Class FeaturestoreServiceClient (3.28.0) 

public class FeaturestoreServiceClient implements BackgroundResource

Service 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:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 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:

  1. 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.
  2. 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.
  3. 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:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 FeaturestoreServiceSettings featurestoreServiceSettings =
     FeaturestoreServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 FeaturestoreServiceClient featurestoreServiceClient =
     FeaturestoreServiceClient.create(featurestoreServiceSettings);

To customize the endpoint:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 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.

Inheritance

java.lang.Object > FeaturestoreServiceClient

Implements

BackgroundResource

Static Methods

create()

public static final FeaturestoreServiceClient create()

Constructs an instance of FeaturestoreServiceClient with default settings.

Returns
Type Description
FeaturestoreServiceClient
Exceptions
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.

Parameter
Name Description
settings FeaturestoreServiceSettings
Returns
Type Description
FeaturestoreServiceClient
Exceptions
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).

Parameter
Name Description
stub FeaturestoreServiceStub
Returns
Type Description
FeaturestoreServiceClient

Constructors

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.

Parameter
Name Description
settings FeaturestoreServiceSettings

FeaturestoreServiceClient(FeaturestoreServiceStub stub)

protected FeaturestoreServiceClient(FeaturestoreServiceStub stub)
Parameter
Name Description
stub FeaturestoreServiceStub

Methods

awaitTermination(long duration, TimeUnit unit)

public boolean awaitTermination(long duration, TimeUnit unit)
Parameters
Name Description
duration long
unit TimeUnit
Returns
Type Description
boolean
Exceptions
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:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (FeaturestoreServiceClient featurestoreServiceClient = FeaturestoreServiceClient.create()) {
   BatchCreateFeaturesRequest request =
       BatchCreateFeaturesRequest.newBuilder()
           .setParent(
               EntityTypeName.of("[PROJECT]", "[LOCATION]", "[FEATURESTORE]", "[ENTITY_TYPE]")
                   .toString())
           .addAllRequests(new ArrayList<CreateFeatureRequest>())
           .build();
   BatchCreateFeaturesResponse response =
       featurestoreServiceClient.batchCreateFeaturesAsync(request).get();
 }
Parameter
Name Description
request BatchCreateFeaturesRequest

The request object containing all of the parameters for the API call.
Returns
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:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (FeaturestoreServiceClient featurestoreServiceClient = FeaturestoreServiceClient.create()) {
   EntityTypeName parent =
       EntityTypeName.of("[PROJECT]", "[LOCATION]", "[FEATURESTORE]", "[ENTITY_TYPE]");
   List<CreateFeatureRequest> requests = new ArrayList<>();
   BatchCreateFeaturesResponse response =
       featurestoreServiceClient.batchCreateFeaturesAsync(parent, requests).get();
 }
Parameters
Name Description
parent EntityTypeName

Required. The resource name of the EntityType to create the batch of Features under. Format: projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}
requests List<CreateFeatureRequest>

Required. The request message specifying the Features to create. All Features must be created under the same parent EntityType. The parent field in each child request message can be omitted. If parent is set in a child request, then the value must match the parent value in this request message.
Returns
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:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (FeaturestoreServiceClient featurestoreServiceClient = FeaturestoreServiceClient.create()) {
   String parent =
       EntityTypeName.of("[PROJECT]", "[LOCATION]", "[FEATURESTORE]", "[ENTITY_TYPE]")
           .toString();
   List<CreateFeatureRequest> requests = new ArrayList<>();
   BatchCreateFeaturesResponse response =
       featurestoreServiceClient.batchCreateFeaturesAsync(parent, requests).get();
 }
Parameters
Name Description
parent String

Required. The resource name of the EntityType to create the batch of Features under. Format: projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}
requests List<CreateFeatureRequest>

Required. The request message specifying the Features to create. All Features must be created under the same parent EntityType. The parent field in each child request message can be omitted. If parent is set in a child request, then the value must match the parent value in this request message.
Returns
Type Description
OperationFuture<BatchCreateFeaturesResponse,BatchCreateFeaturesOperationMetadata>

batchCreateFeaturesCallable()

public final UnaryCallable<BatchCreateFeaturesRequest,Operation> batchCreateFeaturesCallable()

Creates a batch of Features in a given EntityType.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (FeaturestoreServiceClient featurestoreServiceClient = FeaturestoreServiceClient.create()) {
   BatchCreateFeaturesRequest request =
       BatchCreateFeaturesRequest.newBuilder()
           .setParent(
               EntityTypeName.of("[PROJECT]", "[LOCATION]", "[FEATURESTORE]", "[ENTITY_TYPE]")
                   .toString())
           .addAllRequests(new ArrayList<CreateFeatureRequest>())
           .build();
   ApiFuture<Operation> future =
       featurestoreServiceClient.batchCreateFeaturesCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
Returns
Type Description
UnaryCallable<BatchCreateFeaturesRequest,Operation>

batchCreateFeaturesOperationCallable()

public final OperationCallable<BatchCreateFeaturesRequest,BatchCreateFeaturesResponse,BatchCreateFeaturesOperationMetadata> batchCreateFeaturesOperationCallable()

Creates a batch of Features in a given EntityType.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (FeaturestoreServiceClient featurestoreServiceClient = FeaturestoreServiceClient.create()) {
   BatchCreateFeaturesRequest request =
       BatchCreateFeaturesRequest.newBuilder()
           .setParent(
               EntityTypeName.of("[PROJECT]", "[LOCATION]", "[FEATURESTORE]", "[ENTITY_TYPE]")
                   .toString())
           .addAllRequests(new ArrayList<CreateFeatureRequest>())
           .build();
   OperationFuture<BatchCreateFeaturesResponse, BatchCreateFeaturesOperationMetadata> future =
       featurestoreServiceClient.batchCreateFeaturesOperationCallable().futureCall(request);
   // Do something.
   BatchCreateFeaturesResponse response = future.get();
 }
Returns
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:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (FeaturestoreServiceClient featurestoreServiceClient = FeaturestoreServiceClient.create()) {
   BatchReadFeatureValuesRequest request =
       BatchReadFeatureValuesRequest.newBuilder()
           .setFeaturestore(
               FeaturestoreName.of("[PROJECT]", "[LOCATION]", "[FEATURESTORE]").toString())
           .setDestination(FeatureValueDestination.newBuilder().build())
           .addAllPassThroughFields(
               new ArrayList<BatchReadFeatureValuesRequest.PassThroughField>())
           .addAllEntityTypeSpecs(new ArrayList<BatchReadFeatureValuesRequest.EntityTypeSpec>())
           .setStartTime(Timestamp.newBuilder().build())
           .build();
   BatchReadFeatureValuesResponse response =
       featurestoreServiceClient.batchReadFeatureValuesAsync(request).get();
 }
Parameter
Name Description
request BatchReadFeatureValuesRequest

The request object containing all of the parameters for the API call.
Returns
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:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (FeaturestoreServiceClient featurestoreServiceClient = FeaturestoreServiceClient.create()) {
   FeaturestoreName featurestore =
       FeaturestoreName.of("[PROJECT]", "[LOCATION]", "[FEATURESTORE]");
   BatchReadFeatureValuesResponse response =
       featurestoreServiceClient.batchReadFeatureValuesAsync(featurestore).get();
 }
Parameter
Name Description
featurestore FeaturestoreName

Required. The resource name of the Featurestore from which to query Feature values. Format: projects/{project}/locations/{location}/featurestores/{featurestore}
Returns
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:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (FeaturestoreServiceClient featurestoreServiceClient = FeaturestoreServiceClient.create()) {
   String featurestore =
       FeaturestoreName.of("[PROJECT]", "[LOCATION]", "[FEATURESTORE]").toString();
   BatchReadFeatureValuesResponse response =
       featurestoreServiceClient.batchReadFeatureValuesAsync(featurestore).get();
 }
Parameter
Name Description
featurestore String

Required. The resource name of the Featurestore from which to query Feature values. Format: projects/{project}/locations/{location}/featurestores/{featurestore}
Returns
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:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (FeaturestoreServiceClient featurestoreServiceClient = FeaturestoreServiceClient.create()) {
   BatchReadFeatureValuesRequest request =
       BatchReadFeatureValuesRequest.newBuilder()
           .setFeaturestore(
               FeaturestoreName.of("[PROJECT]", "[LOCATION]", "[FEATURESTORE]").toString())
           .setDestination(FeatureValueDestination.newBuilder().build())
           .addAllPassThroughFields(
               new ArrayList<BatchReadFeatureValuesRequest.PassThroughField>())
           .addAllEntityTypeSpecs(new ArrayList<BatchReadFeatureValuesRequest.EntityTypeSpec>())
           .setStartTime(Timestamp.newBuilder().build())
           .build();
   ApiFuture<Operation> future =
       featurestoreServiceClient.batchReadFeatureValuesCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
Returns
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:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (FeaturestoreServiceClient featurestoreServiceClient = FeaturestoreServiceClient.create()) {
   BatchReadFeatureValuesRequest request =
       BatchReadFeatureValuesRequest.newBuilder()
           .setFeaturestore(
               FeaturestoreName.of("[PROJECT]", "[LOCATION]", "[FEATURESTORE]").toString())
           .setDestination(FeatureValueDestination.newBuilder().build())
           .addAllPassThroughFields(
               new ArrayList<BatchReadFeatureValuesRequest.PassThroughField>())
           .addAllEntityTypeSpecs(new ArrayList<BatchReadFeatureValuesRequest.EntityTypeSpec>())
           .setStartTime(Timestamp.newBuilder().build())
           .build();
   OperationFuture<BatchReadFeatureValuesResponse, BatchReadFeatureValuesOperationMetadata>
       future =
           featurestoreServiceClient
               .batchReadFeatureValuesOperationCallable()
               .futureCall(request);
   // Do something.
   BatchReadFeatureValuesResponse response = future.get();
 }
Returns
Type Description
OperationCallable<BatchReadFeatureValuesRequest,BatchReadFeatureValuesResponse,BatchReadFeatureValuesOperationMetadata>

close()

public final void close()

createEntityTypeAsync(CreateEntityTypeRequest request)

public final OperationFuture<EntityType,CreateEntityTypeOperationMetadata> createEntityTypeAsync(CreateEntityTypeRequest request)

Creates a new EntityType in a given Featurestore.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 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();
 }
Parameter
Name Description
request CreateEntityTypeRequest

The request object containing all of the parameters for the API call.
Returns
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:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (FeaturestoreServiceClient featurestoreServiceClient = FeaturestoreServiceClient.create()) {
   FeaturestoreName parent = FeaturestoreName.of("[PROJECT]", "[LOCATION]", "[FEATURESTORE]");
   EntityType entityType = EntityType.newBuilder().build();
   EntityType response =
       featurestoreServiceClient.createEntityTypeAsync(parent, entityType).get();
 }
Parameters
Name Description
parent FeaturestoreName

Required. The resource name of the Featurestore to create EntityTypes. Format: projects/{project}/locations/{location}/featurestores/{featurestore}
entityType EntityType

The EntityType to create.
Returns
Type Description
OperationFuture<EntityType,CreateEntityTypeOperationMetadata>

createEntityTypeAsync(FeaturestoreName parent, EntityType entityType, String entityTypeId)

public final OperationFuture<EntityType,CreateEntityTypeOperationMetadata> createEntityTypeAsync(FeaturestoreName parent, EntityType entityType, String entityTypeId)

Creates a new EntityType in a given Featurestore.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (FeaturestoreServiceClient featurestoreServiceClient = FeaturestoreServiceClient.create()) {
   FeaturestoreName parent = FeaturestoreName.of("[PROJECT]", "[LOCATION]", "[FEATURESTORE]");
   EntityType entityType = EntityType.newBuilder().build();
   String entityTypeId = "entityTypeId767740856";
   EntityType response =
       featurestoreServiceClient.createEntityTypeAsync(parent, entityType, entityTypeId).get();
 }
Parameters
Name Description
parent FeaturestoreName

Required. The resource name of the Featurestore to create EntityTypes. Format: projects/{project}/locations/{location}/featurestores/{featurestore}
entityType EntityType

The EntityType to create.
entityTypeId String

Required. The ID to use for the EntityType, which will become the final component of the EntityType'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 featurestore.
Returns
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:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 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();
 }
Parameters
Name Description
parent String

Required. The resource name of the Featurestore to create EntityTypes. Format: projects/{project}/locations/{location}/featurestores/{featurestore}
entityType EntityType

The EntityType to create.
Returns
Type Description
OperationFuture<EntityType,CreateEntityTypeOperationMetadata>

createEntityTypeAsync(String parent, EntityType entityType, String entityTypeId)

public final OperationFuture<EntityType,CreateEntityTypeOperationMetadata> createEntityTypeAsync(String parent, EntityType entityType, String entityTypeId)

Creates a new EntityType in a given Featurestore.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (FeaturestoreServiceClient featurestoreServiceClient = FeaturestoreServiceClient.create()) {
   String parent = FeaturestoreName.of("[PROJECT]", "[LOCATION]", "[FEATURESTORE]").toString();
   EntityType entityType = EntityType.newBuilder().build();
   String entityTypeId = "entityTypeId767740856";
   EntityType response =
       featurestoreServiceClient.createEntityTypeAsync(parent, entityType, entityTypeId).get();
 }
Parameters
Name Description
parent String

Required. The resource name of the Featurestore to create EntityTypes. Format: projects/{project}/locations/{location}/featurestores/{featurestore}
entityType EntityType

The EntityType to create.
entityTypeId String

Required. The ID to use for the EntityType, which will become the final component of the EntityType'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 featurestore.
Returns
Type Description
OperationFuture<EntityType,CreateEntityTypeOperationMetadata>

createEntityTypeCallable()

public final UnaryCallable<CreateEntityTypeRequest,Operation> createEntityTypeCallable()

Creates a new EntityType in a given Featurestore.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (FeaturestoreServiceClient featurestoreServiceClient = FeaturestoreServiceClient.create()) {
   CreateEntityTypeRequest request =
       CreateEntityTypeRequest.newBuilder()
           .setParent(
               FeaturestoreName.of("[PROJECT]", "[LOCATION]", "[FEATURESTORE]").toString())
           .setEntityType(EntityType.newBuilder().build())
           .setEntityTypeId("entityTypeId767740856")
           .build();
   ApiFuture<Operation> future =
       featurestoreServiceClient.createEntityTypeCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
Returns
Type Description
UnaryCallable<CreateEntityTypeRequest,Operation>

createEntityTypeOperationCallable()

public final OperationCallable<CreateEntityTypeRequest,EntityType,CreateEntityTypeOperationMetadata> createEntityTypeOperationCallable()

Creates a new EntityType in a given Featurestore.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (FeaturestoreServiceClient featurestoreServiceClient = FeaturestoreServiceClient.create()) {
   CreateEntityTypeRequest request =
       CreateEntityTypeRequest.newBuilder()
           .setParent(
               FeaturestoreName.of("[PROJECT]", "[LOCATION]", "[FEATURESTORE]").toString())
           .setEntityType(EntityType.newBuilder().build())
           .setEntityTypeId("entityTypeId767740856")
           .build();
   OperationFuture<EntityType, CreateEntityTypeOperationMetadata> future =
       featurestoreServiceClient.createEntityTypeOperationCallable().futureCall(request);
   // Do something.
   EntityType response = future.get();
 }
Returns
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:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 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();
 }
Parameter
Name Description
request CreateFeatureRequest

The request object containing all of the parameters for the API call.
Returns
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:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 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();
 }
Parameters
Name Description
parent EntityTypeName

The resource name of the EntityType or FeatureGroup to create a Feature. Format: projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type} projects/{project}/locations/{location}/featureGroups/{feature_group}
feature Feature

Required. The Feature to create.
Returns
Type Description
OperationFuture<Feature,CreateFeatureOperationMetadata>

createFeatureAsync(EntityTypeName parent, Feature feature, String featureId)

public final OperationFuture<Feature,CreateFeatureOperationMetadata> createFeatureAsync(EntityTypeName parent, Feature feature, String featureId)

Creates a new Feature in a given EntityType.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (FeaturestoreServiceClient featurestoreServiceClient = FeaturestoreServiceClient.create()) {
   EntityTypeName parent =
       EntityTypeName.of("[PROJECT]", "[LOCATION]", "[FEATURESTORE]", "[ENTITY_TYPE]");
   Feature feature = Feature.newBuilder().build();
   String featureId = "featureId-420503887";
   Feature response =
       featurestoreServiceClient.createFeatureAsync(parent, feature, featureId).get();
 }
Parameters
Name Description
parent EntityTypeName

The resource name of the EntityType or FeatureGroup to create a Feature. Format: projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type} projects/{project}/locations/{location}/featureGroups/{feature_group}
feature Feature

Required. The Feature to create.
featureId String

Required. The ID to use for the Feature, which will become the final component of the Feature's resource name.

This value may be up to 128 characters, and valid characters are [a-z0-9_]. The first character cannot be a number.

The value must be unique within an EntityType/FeatureGroup.
Returns
Type Description
OperationFuture<Feature,CreateFeatureOperationMetadata>

createFeatureAsync(FeatureGroupName parent, Feature feature)

public final OperationFuture<Feature,CreateFeatureOperationMetadata> createFeatureAsync(FeatureGroupName parent, Feature feature)

Creates a new Feature in a given EntityType.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (FeaturestoreServiceClient featurestoreServiceClient = FeaturestoreServiceClient.create()) {
   FeatureGroupName parent = FeatureGroupName.of("[PROJECT]", "[LOCATION]", "[FEATURE_GROUP]");
   Feature feature = Feature.newBuilder().build();
   Feature response = featurestoreServiceClient.createFeatureAsync(parent, feature).get();
 }
Parameters
Name Description
parent FeatureGroupName

The resource name of the EntityType or FeatureGroup to create a Feature. Format: projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type} projects/{project}/locations/{location}/featureGroups/{feature_group}
feature Feature

Required. The Feature to create.
Returns
Type Description
OperationFuture<Feature,CreateFeatureOperationMetadata>

createFeatureAsync(FeatureGroupName parent, Feature feature, String featureId)

public final OperationFuture<Feature,CreateFeatureOperationMetadata> createFeatureAsync(FeatureGroupName parent, Feature feature, String featureId)

Creates a new Feature in a given EntityType.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (FeaturestoreServiceClient featurestoreServiceClient = FeaturestoreServiceClient.create()) {
   FeatureGroupName parent = FeatureGroupName.of("[PROJECT]", "[LOCATION]", "[FEATURE_GROUP]");
   Feature feature = Feature.newBuilder().build();
   String featureId = "featureId-420503887";
   Feature response =
       featurestoreServiceClient.createFeatureAsync(parent, feature, featureId).get();
 }
Parameters
Name Description
parent FeatureGroupName

The resource name of the EntityType or FeatureGroup to create a Feature. Format: projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type} projects/{project}/locations/{location}/featureGroups/{feature_group}
feature Feature

Required. The Feature to create.
featureId String

Required. The ID to use for the Feature, which will become the final component of the Feature's resource name.

This value may be up to 128 characters, and valid characters are [a-z0-9_]. The first character cannot be a number.

The value must be unique within an EntityType/FeatureGroup.
Returns
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:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 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();
 }
Parameters
Name Description
parent String

The resource name of the EntityType or FeatureGroup to create a Feature. Format: projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type} projects/{project}/locations/{location}/featureGroups/{feature_group}
feature Feature

Required. The Feature to create.
Returns
Type Description
OperationFuture<Feature,CreateFeatureOperationMetadata>

createFeatureAsync(String parent, Feature feature, String featureId)

public final OperationFuture<Feature,CreateFeatureOperationMetadata> createFeatureAsync(String parent, Feature feature, String featureId)

Creates a new Feature in a given EntityType.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (FeaturestoreServiceClient featurestoreServiceClient = FeaturestoreServiceClient.create()) {
   String parent =
       EntityTypeName.of("[PROJECT]", "[LOCATION]", "[FEATURESTORE]", "[ENTITY_TYPE]")
           .toString();
   Feature feature = Feature.newBuilder().build();
   String featureId = "featureId-420503887";
   Feature response =
       featurestoreServiceClient.createFeatureAsync(parent, feature, featureId).get();
 }
Parameters
Name Description
parent String

The resource name of the EntityType or FeatureGroup to create a Feature. Format: projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type} projects/{project}/locations/{location}/featureGroups/{feature_group}
feature Feature

Required. The Feature to create.
featureId String

Required. The ID to use for the Feature, which will become the final component of the Feature's resource name.

This value may be up to 128 characters, and valid characters are [a-z0-9_]. The first character cannot be a number.

The value must be unique within an EntityType/FeatureGroup.
Returns
Type Description
OperationFuture<Feature,CreateFeatureOperationMetadata>

createFeatureCallable()

public final UnaryCallable<CreateFeatureRequest,Operation> createFeatureCallable()

Creates a new Feature in a given EntityType.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 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<Operation> future =
       featurestoreServiceClient.createFeatureCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
Returns
Type Description
UnaryCallable<CreateFeatureRequest,Operation>

createFeatureOperationCallable()

public final OperationCallable<CreateFeatureRequest,Feature,CreateFeatureOperationMetadata> createFeatureOperationCallable()

Creates a new Feature in a given EntityType.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 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<Feature, CreateFeatureOperationMetadata> future =
       featurestoreServiceClient.createFeatureOperationCallable().futureCall(request);
   // Do something.
   Feature response = future.get();
 }
Returns
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:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 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();
 }
Parameter
Name Description
request CreateFeaturestoreRequest

The request object containing all of the parameters for the API call.
Returns
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:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (FeaturestoreServiceClient featurestoreServiceClient = FeaturestoreServiceClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   Featurestore featurestore = Featurestore.newBuilder().build();
   Featurestore response =
       featurestoreServiceClient.createFeaturestoreAsync(parent, featurestore).get();
 }
Parameters
Name Description
parent LocationName

Required. The resource name of the Location to create Featurestores. Format: projects/{project}/locations/{location}
featurestore Featurestore

Required. The Featurestore to create.
Returns
Type Description
OperationFuture<Featurestore,CreateFeaturestoreOperationMetadata>

createFeaturestoreAsync(LocationName parent, Featurestore featurestore, String featurestoreId)

public final OperationFuture<Featurestore,CreateFeaturestoreOperationMetadata> createFeaturestoreAsync(LocationName parent, Featurestore featurestore, String featurestoreId)

Creates a new Featurestore in a given project and location.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (FeaturestoreServiceClient featurestoreServiceClient = FeaturestoreServiceClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   Featurestore featurestore = Featurestore.newBuilder().build();
   String featurestoreId = "featurestoreId-1315851738";
   Featurestore response =
       featurestoreServiceClient
           .createFeaturestoreAsync(parent, featurestore, featurestoreId)
           .get();
 }
Parameters
Name Description
parent LocationName

Required. The resource name of the Location to create Featurestores. Format: projects/{project}/locations/{location}
featurestore Featurestore

Required. The Featurestore to create.
featurestoreId String

Required. The ID to use for this Featurestore, which will become the final component of the Featurestore's resource name.

This value may be up to 60 characters, and valid characters are [a-z0-9_]. The first character cannot be a number.

The value must be unique within the project and location.
Returns
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:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (FeaturestoreServiceClient featurestoreServiceClient = FeaturestoreServiceClient.create()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   Featurestore featurestore = Featurestore.newBuilder().build();
   Featurestore response =
       featurestoreServiceClient.createFeaturestoreAsync(parent, featurestore).get();
 }
Parameters
Name Description
parent String

Required. The resource name of the Location to create Featurestores. Format: projects/{project}/locations/{location}
featurestore Featurestore

Required. The Featurestore to create.
Returns
Type Description
OperationFuture<Featurestore,CreateFeaturestoreOperationMetadata>

createFeaturestoreAsync(String parent, Featurestore featurestore, String featurestoreId)

public final OperationFuture<Featurestore,CreateFeaturestoreOperationMetadata> createFeaturestoreAsync(String parent, Featurestore featurestore, String featurestoreId)

Creates a new Featurestore in a given project and location.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (FeaturestoreServiceClient featurestoreServiceClient = FeaturestoreServiceClient.create()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   Featurestore featurestore = Featurestore.newBuilder().build();
   String featurestoreId = "featurestoreId-1315851738";
   Featurestore response =
       featurestoreServiceClient
           .createFeaturestoreAsync(parent, featurestore, featurestoreId)
           .get();
 }
Parameters
Name Description
parent String

Required. The resource name of the Location to create Featurestores. Format: projects/{project}/locations/{location}
featurestore Featurestore

Required. The Featurestore to create.
featurestoreId String

Required. The ID to use for this Featurestore, which will become the final component of the Featurestore's resource name.

This value may be up to 60 characters, and valid characters are [a-z0-9_]. The first character cannot be a number.

The value must be unique within the project and location.
Returns
Type Description
OperationFuture<Featurestore,CreateFeaturestoreOperationMetadata>

createFeaturestoreCallable()

public final UnaryCallable<CreateFeaturestoreRequest,Operation> createFeaturestoreCallable()

Creates a new Featurestore in a given project and location.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (FeaturestoreServiceClient featurestoreServiceClient = FeaturestoreServiceClient.create()) {
   CreateFeaturestoreRequest request =
       CreateFeaturestoreRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setFeaturestore(Featurestore.newBuilder().build())
           .setFeaturestoreId("featurestoreId-1315851738")
           .build();
   ApiFuture<Operation> future =
       featurestoreServiceClient.createFeaturestoreCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
Returns
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:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (FeaturestoreServiceClient featurestoreServiceClient = FeaturestoreServiceClient.create()) {
   CreateFeaturestoreRequest request =
       CreateFeaturestoreRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setFeaturestore(Featurestore.newBuilder().build())
           .setFeaturestoreId("featurestoreId-1315851738")
           .build();
   OperationFuture<Featurestore, CreateFeaturestoreOperationMetadata> future =
       featurestoreServiceClient.createFeaturestoreOperationCallable().futureCall(request);
   // Do something.
   Featurestore response = future.get();
 }
Returns
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:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 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();
 }
Parameter
Name Description
request DeleteEntityTypeRequest

The request object containing all of the parameters for the API call.
Returns
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:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (FeaturestoreServiceClient featurestoreServiceClient = FeaturestoreServiceClient.create()) {
   EntityTypeName name =
       EntityTypeName.of("[PROJECT]", "[LOCATION]", "[FEATURESTORE]", "[ENTITY_TYPE]");
   featurestoreServiceClient.deleteEntityTypeAsync(name).get();
 }
Parameter
Name Description
name EntityTypeName

Required. The name of the EntityType to be deleted. Format: projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}
Returns
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:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (FeaturestoreServiceClient featurestoreServiceClient = FeaturestoreServiceClient.create()) {
   EntityTypeName name =
       EntityTypeName.of("[PROJECT]", "[LOCATION]", "[FEATURESTORE]", "[ENTITY_TYPE]");
   boolean force = true;
   featurestoreServiceClient.deleteEntityTypeAsync(name, force).get();
 }
Parameters
Name Description
name EntityTypeName

Required. The name of the EntityType to be deleted. Format: projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}
force boolean

If set to true, any Features for this EntityType will also be deleted. (Otherwise, the request will only work if the EntityType has no Features.)
Returns
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:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (FeaturestoreServiceClient featurestoreServiceClient = FeaturestoreServiceClient.create()) {
   String name =
       EntityTypeName.of("[PROJECT]", "[LOCATION]", "[FEATURESTORE]", "[ENTITY_TYPE]")
           .toString();
   featurestoreServiceClient.deleteEntityTypeAsync(name).get();
 }
Parameter
Name Description
name String

Required. The name of the EntityType to be deleted. Format: projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}
Returns
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:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (FeaturestoreServiceClient featurestoreServiceClient = FeaturestoreServiceClient.create()) {
   String name =
       EntityTypeName.of("[PROJECT]", "[LOCATION]", "[FEATURESTORE]", "[ENTITY_TYPE]")
           .toString();
   boolean force = true;
   featurestoreServiceClient.deleteEntityTypeAsync(name, force).get();
 }
Parameters
Name Description
name String

Required. The name of the EntityType to be deleted. Format: projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}
force boolean

If set to true, any Features for this EntityType will also be deleted. (Otherwise, the request will only work if the EntityType has no Features.)
Returns
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:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (FeaturestoreServiceClient featurestoreServiceClient = FeaturestoreServiceClient.create()) {
   DeleteEntityTypeRequest request =
       DeleteEntityTypeRequest.newBuilder()
           .setName(
               EntityTypeName.of("[PROJECT]", "[LOCATION]", "[FEATURESTORE]", "[ENTITY_TYPE]")
                   .toString())
           .setForce(true)
           .build();
   ApiFuture<Operation> future =
       featurestoreServiceClient.deleteEntityTypeCallable().futureCall(request);
   // Do something.
   future.get();
 }
Returns
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:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (FeaturestoreServiceClient featurestoreServiceClient = FeaturestoreServiceClient.create()) {
   DeleteEntityTypeRequest request =
       DeleteEntityTypeRequest.newBuilder()
           .setName(
               EntityTypeName.of("[PROJECT]", "[LOCATION]", "[FEATURESTORE]", "[ENTITY_TYPE]")
                   .toString())
           .setForce(true)
           .build();
   OperationFuture<Empty, DeleteOperationMetadata> future =
       featurestoreServiceClient.deleteEntityTypeOperationCallable().futureCall(request);
   // Do something.
   future.get();
 }
Returns
Type Description
OperationCallable<DeleteEntityTypeRequest,Empty,DeleteOperationMetadata>

deleteFeatureAsync(DeleteFeatureRequest request)

public final OperationFuture<Empty,DeleteOperationMetadata> deleteFeatureAsync(DeleteFeatureRequest request)

Deletes a single Feature.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (FeaturestoreServiceClient featurestoreServiceClient = FeaturestoreServiceClient.create()) {
   DeleteFeatureRequest request =
       DeleteFeatureRequest.newBuilder()
           .setName(
               FeatureName.ofProjectLocationFeaturestoreEntityTypeFeatureName(
                       "[PROJECT]", "[LOCATION]", "[FEATURESTORE]", "[ENTITY_TYPE]", "[FEATURE]")
                   .toString())
           .build();
   featurestoreServiceClient.deleteFeatureAsync(request).get();
 }
Parameter
Name Description
request DeleteFeatureRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
OperationFuture<Empty,DeleteOperationMetadata>

deleteFeatureAsync(FeatureName name)

public final OperationFuture<Empty,DeleteOperationMetadata> deleteFeatureAsync(FeatureName name)

Deletes a single Feature.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (FeaturestoreServiceClient featurestoreServiceClient = FeaturestoreServiceClient.create()) {
   FeatureName name =
       FeatureName.ofProjectLocationFeaturestoreEntityTypeFeatureName(
           "[PROJECT]", "[LOCATION]", "[FEATURESTORE]", "[ENTITY_TYPE]", "[FEATURE]");
   featurestoreServiceClient.deleteFeatureAsync(name).get();
 }
Parameter
Name Description
name FeatureName

Required. The name of the Features to be deleted. Format: projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}/features/{feature} projects/{project}/locations/{location}/featureGroups/{feature_group}/features/{feature}
Returns
Type Description
OperationFuture<Empty,DeleteOperationMetadata>

deleteFeatureAsync(String name)

public final OperationFuture<Empty,DeleteOperationMetadata> deleteFeatureAsync(String name)

Deletes a single Feature.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (FeaturestoreServiceClient featurestoreServiceClient = FeaturestoreServiceClient.create()) {
   String name =
       FeatureName.ofProjectLocationFeaturestoreEntityTypeFeatureName(
               "[PROJECT]", "[LOCATION]", "[FEATURESTORE]", "[ENTITY_TYPE]", "[FEATURE]")
           .toString();
   featurestoreServiceClient.deleteFeatureAsync(name).get();
 }
Parameter
Name Description
name String

Required. The name of the Features to be deleted. Format: projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}/features/{feature} projects/{project}/locations/{location}/featureGroups/{feature_group}/features/{feature}
Returns
Type Description
OperationFuture<Empty,DeleteOperationMetadata>

deleteFeatureCallable()

public final UnaryCallable<DeleteFeatureRequest,Operation> deleteFeatureCallable()

Deletes a single Feature.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (FeaturestoreServiceClient featurestoreServiceClient = FeaturestoreServiceClient.create()) {
   DeleteFeatureRequest request =
       DeleteFeatureRequest.newBuilder()
           .setName(
               FeatureName.ofProjectLocationFeaturestoreEntityTypeFeatureName(
                       "[PROJECT]", "[LOCATION]", "[FEATURESTORE]", "[ENTITY_TYPE]", "[FEATURE]")
                   .toString())
           .build();
   ApiFuture<Operation> future =
       featurestoreServiceClient.deleteFeatureCallable().futureCall(request);
   // Do something.
   future.get();
 }
Returns
Type Description
UnaryCallable<DeleteFeatureRequest,Operation>

deleteFeatureOperationCallable()

public final OperationCallable<DeleteFeatureRequest,Empty,DeleteOperationMetadata> deleteFeatureOperationCallable()

Deletes a single Feature.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (FeaturestoreServiceClient featurestoreServiceClient = FeaturestoreServiceClient.create()) {
   DeleteFeatureRequest request =
       DeleteFeatureRequest.newBuilder()
           .setName(
               FeatureName.ofProjectLocationFeaturestoreEntityTypeFeatureName(
                       "[PROJECT]", "[LOCATION]", "[FEATURESTORE]", "[ENTITY_TYPE]", "[FEATURE]")
                   .toString())
           .build();
   OperationFuture<Empty, DeleteOperationMetadata> future =
       featurestoreServiceClient.deleteFeatureOperationCallable().futureCall(request);
   // Do something.
   future.get();
 }
Returns
Type Description
OperationCallable<DeleteFeatureRequest,Empty,DeleteOperationMetadata>

deleteFeatureValuesAsync(DeleteFeatureValuesRequest request)

public final OperationFuture<DeleteFeatureValuesResponse,DeleteFeatureValuesOperationMetadata> deleteFeatureValuesAsync(DeleteFeatureValuesRequest request)

Delete Feature values from Featurestore.

The progress of the deletion is tracked by the returned operation. The deleted feature values are guaranteed to be invisible to subsequent read operations after the operation is marked as successfully done.

If a delete feature values operation fails, the feature values returned from reads and exports may be inconsistent. If consistency is required, the caller must retry the same delete request again and wait till the new operation returned is marked as successfully done.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (FeaturestoreServiceClient featurestoreServiceClient = FeaturestoreServiceClient.create()) {
   DeleteFeatureValuesRequest request =
       DeleteFeatureValuesRequest.newBuilder()
           .setEntityType(
               EntityTypeName.of("[PROJECT]", "[LOCATION]", "[FEATURESTORE]", "[ENTITY_TYPE]")
                   .toString())
           .build();
   DeleteFeatureValuesResponse response =
       featurestoreServiceClient.deleteFeatureValuesAsync(request).get();
 }
Parameter
Name Description
request DeleteFeatureValuesRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
OperationFuture<DeleteFeatureValuesResponse,DeleteFeatureValuesOperationMetadata>

deleteFeatureValuesAsync(EntityTypeName entityType)

public final OperationFuture<DeleteFeatureValuesResponse,DeleteFeatureValuesOperationMetadata> deleteFeatureValuesAsync(EntityTypeName entityType)

Delete Feature values from Featurestore.

The progress of the deletion is tracked by the returned operation. The deleted feature values are guaranteed to be invisible to subsequent read operations after the operation is marked as successfully done.

If a delete feature values operation fails, the feature values returned from reads and exports may be inconsistent. If consistency is required, the caller must retry the same delete request again and wait till the new operation returned is marked as successfully done.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (FeaturestoreServiceClient featurestoreServiceClient = FeaturestoreServiceClient.create()) {
   EntityTypeName entityType =
       EntityTypeName.of("[PROJECT]", "[LOCATION]", "[FEATURESTORE]", "[ENTITY_TYPE]");
   DeleteFeatureValuesResponse response =
       featurestoreServiceClient.deleteFeatureValuesAsync(entityType).get();
 }
Parameter
Name Description
entityType EntityTypeName

Required. The resource name of the EntityType grouping the Features for which values are being deleted from. Format: projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entityType}
Returns
Type Description
OperationFuture<DeleteFeatureValuesResponse,DeleteFeatureValuesOperationMetadata>

deleteFeatureValuesAsync(String entityType)

public final OperationFuture<DeleteFeatureValuesResponse,DeleteFeatureValuesOperationMetadata> deleteFeatureValuesAsync(String entityType)

Delete Feature values from Featurestore.

The progress of the deletion is tracked by the returned operation. The deleted feature values are guaranteed to be invisible to subsequent read operations after the operation is marked as successfully done.

If a delete feature values operation fails, the feature values returned from reads and exports may be inconsistent. If consistency is required, the caller must retry the same delete request again and wait till the new operation returned is marked as successfully done.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (FeaturestoreServiceClient featurestoreServiceClient = FeaturestoreServiceClient.create()) {
   String entityType =
       EntityTypeName.of("[PROJECT]", "[LOCATION]", "[FEATURESTORE]", "[ENTITY_TYPE]")
           .toString();
   DeleteFeatureValuesResponse response =
       featurestoreServiceClient.deleteFeatureValuesAsync(entityType).get();
 }
Parameter
Name Description
entityType String

Required. The resource name of the EntityType grouping the Features for which values are being deleted from. Format: projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entityType}
Returns
Type Description
OperationFuture<DeleteFeatureValuesResponse,DeleteFeatureValuesOperationMetadata>

deleteFeatureValuesCallable()

public final UnaryCallable<DeleteFeatureValuesRequest,Operation> deleteFeatureValuesCallable()

Delete Feature values from Featurestore.

The progress of the deletion is tracked by the returned operation. The deleted feature values are guaranteed to be invisible to subsequent read operations after the operation is marked as successfully done.

If a delete feature values operation fails, the feature values returned from reads and exports may be inconsistent. If consistency is required, the caller must retry the same delete request again and wait till the new operation returned is marked as successfully done.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (FeaturestoreServiceClient featurestoreServiceClient = FeaturestoreServiceClient.create()) {
   DeleteFeatureValuesRequest request =
       DeleteFeatureValuesRequest.newBuilder()
           .setEntityType(
               EntityTypeName.of("[PROJECT]", "[LOCATION]", "[FEATURESTORE]", "[ENTITY_TYPE]")
                   .toString())
           .build();
   ApiFuture<Operation> future =
       featurestoreServiceClient.deleteFeatureValuesCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
Returns
Type Description
UnaryCallable<DeleteFeatureValuesRequest,Operation>

deleteFeatureValuesOperationCallable()

public final OperationCallable<DeleteFeatureValuesRequest,DeleteFeatureValuesResponse,DeleteFeatureValuesOperationMetadata> deleteFeatureValuesOperationCallable()

Delete Feature values from Featurestore.

The progress of the deletion is tracked by the returned operation. The deleted feature values are guaranteed to be invisible to subsequent read operations after the operation is marked as successfully done.

If a delete feature values operation fails, the feature values returned from reads and exports may be inconsistent. If consistency is required, the caller must retry the same delete request again and wait till the new operation returned is marked as successfully done.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (FeaturestoreServiceClient featurestoreServiceClient = FeaturestoreServiceClient.create()) {
   DeleteFeatureValuesRequest request =
       DeleteFeatureValuesRequest.newBuilder()
           .setEntityType(
               EntityTypeName.of("[PROJECT]", "[LOCATION]", "[FEATURESTORE]", "[ENTITY_TYPE]")
                   .toString())
           .build();
   OperationFuture<DeleteFeatureValuesResponse, DeleteFeatureValuesOperationMetadata> future =
       featurestoreServiceClient.deleteFeatureValuesOperationCallable().futureCall(request);
   // Do something.
   DeleteFeatureValuesResponse response = future.get();
 }
Returns
Type Description
OperationCallable<DeleteFeatureValuesRequest,DeleteFeatureValuesResponse,DeleteFeatureValuesOperationMetadata>

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:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (FeaturestoreServiceClient featurestoreServiceClient = FeaturestoreServiceClient.create()) {
   DeleteFeaturestoreRequest request =
       DeleteFeaturestoreRequest.newBuilder()
           .setName(FeaturestoreName.of("[PROJECT]", "[LOCATION]", "[FEATURESTORE]").toString())
           .setForce(true)
           .build();
   featurestoreServiceClient.deleteFeaturestoreAsync(request).get();
 }
Parameter
Name Description
request DeleteFeaturestoreRequest

The request object containing all of the parameters for the API call.
Returns
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:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (FeaturestoreServiceClient featurestoreServiceClient = FeaturestoreServiceClient.create()) {
   FeaturestoreName name = FeaturestoreName.of("[PROJECT]", "[LOCATION]", "[FEATURESTORE]");
   featurestoreServiceClient.deleteFeaturestoreAsync(name).get();
 }
Parameter
Name Description
name FeaturestoreName

Required. The name of the Featurestore to be deleted. Format: projects/{project}/locations/{location}/featurestores/{featurestore}
Returns
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:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (FeaturestoreServiceClient featurestoreServiceClient = FeaturestoreServiceClient.create()) {
   FeaturestoreName name = FeaturestoreName.of("[PROJECT]", "[LOCATION]", "[FEATURESTORE]");
   boolean force = true;
   featurestoreServiceClient.deleteFeaturestoreAsync(name, force).get();
 }
Parameters
Name Description
name FeaturestoreName

Required. The name of the Featurestore to be deleted. Format: projects/{project}/locations/{location}/featurestores/{featurestore}
force boolean

If 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.)
Returns
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:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (FeaturestoreServiceClient featurestoreServiceClient = FeaturestoreServiceClient.create()) {
   String name = FeaturestoreName.of("[PROJECT]", "[LOCATION]", "[FEATURESTORE]").toString();
   featurestoreServiceClient.deleteFeaturestoreAsync(name).get();
 }
Parameter
Name Description
name String

Required. The name of the Featurestore to be deleted. Format: projects/{project}/locations/{location}/featurestores/{featurestore}
Returns
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:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (FeaturestoreServiceClient featurestoreServiceClient = FeaturestoreServiceClient.create()) {
   String name = FeaturestoreName.of("[PROJECT]", "[LOCATION]", "[FEATURESTORE]").toString();
   boolean force = true;
   featurestoreServiceClient.deleteFeaturestoreAsync(name, force).get();
 }
Parameters
Name Description
name String

Required. The name of the Featurestore to be deleted. Format: projects/{project}/locations/{location}/featurestores/{featurestore}
force boolean

If 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.)
Returns
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:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (FeaturestoreServiceClient featurestoreServiceClient = FeaturestoreServiceClient.create()) {
   DeleteFeaturestoreRequest request =
       DeleteFeaturestoreRequest.newBuilder()
           .setName(FeaturestoreName.of("[PROJECT]", "[LOCATION]", "[FEATURESTORE]").toString())
           .setForce(true)
           .build();
   ApiFuture<Operation> future =
       featurestoreServiceClient.deleteFeaturestoreCallable().futureCall(request);
   // Do something.
   future.get();
 }
Returns
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:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (FeaturestoreServiceClient featurestoreServiceClient = FeaturestoreServiceClient.create()) {
   DeleteFeaturestoreRequest request =
       DeleteFeaturestoreRequest.newBuilder()
           .setName(FeaturestoreName.of("[PROJECT]", "[LOCATION]", "[FEATURESTORE]").toString())
           .setForce(true)
           .build();
   OperationFuture<Empty, DeleteOperationMetadata> future =
       featurestoreServiceClient.deleteFeaturestoreOperationCallable().futureCall(request);
   // Do something.
   future.get();
 }
Returns
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:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (FeaturestoreServiceClient featurestoreServiceClient = FeaturestoreServiceClient.create()) {
   EntityTypeName entityType =
       EntityTypeName.of("[PROJECT]", "[LOCATION]", "[FEATURESTORE]", "[ENTITY_TYPE]");
   ExportFeatureValuesResponse response =
       featurestoreServiceClient.exportFeatureValuesAsync(entityType).get();
 }
Parameter
Name Description
entityType EntityTypeName

Required. The resource name of the EntityType from which to export Feature values. Format: projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}
Returns
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:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 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<DestinationFeatureSetting>())
           .build();
   ExportFeatureValuesResponse response =
       featurestoreServiceClient.exportFeatureValuesAsync(request).get();
 }
Parameter
Name Description
request ExportFeatureValuesRequest

The request object containing all of the parameters for the API call.
Returns
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:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (FeaturestoreServiceClient featurestoreServiceClient = FeaturestoreServiceClient.create()) {
   String entityType =
       EntityTypeName.of("[PROJECT]", "[LOCATION]", "[FEATURESTORE]", "[ENTITY_TYPE]")
           .toString();
   ExportFeatureValuesResponse response =
       featurestoreServiceClient.exportFeatureValuesAsync(entityType).get();
 }
Parameter
Name Description
entityType String

Required. The resource name of the EntityType from which to export Feature values. Format: projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}
Returns
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:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 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<DestinationFeatureSetting>())
           .build();
   ApiFuture<Operation> future =
       featurestoreServiceClient.exportFeatureValuesCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
Returns
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:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 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<DestinationFeatureSetting>())
           .build();
   OperationFuture<ExportFeatureValuesResponse, ExportFeatureValuesOperationMetadata> future =
       featurestoreServiceClient.exportFeatureValuesOperationCallable().futureCall(request);
   // Do something.
   ExportFeatureValuesResponse response = future.get();
 }
Returns
Type Description
OperationCallable<ExportFeatureValuesRequest,ExportFeatureValuesResponse,ExportFeatureValuesOperationMetadata>

getEntityType(EntityTypeName name)

public final EntityType getEntityType(EntityTypeName name)

Gets details of a single EntityType.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (FeaturestoreServiceClient featurestoreServiceClient = FeaturestoreServiceClient.create()) {
   EntityTypeName name =
       EntityTypeName.of("[PROJECT]", "[LOCATION]", "[FEATURESTORE]", "[ENTITY_TYPE]");
   EntityType response = featurestoreServiceClient.getEntityType(name);
 }
Parameter
Name Description
name EntityTypeName

Required. The name of the EntityType resource. Format: projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}
Returns
Type Description
EntityType

getEntityType(GetEntityTypeRequest request)

public final EntityType getEntityType(GetEntityTypeRequest request)

Gets details of a single EntityType.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (FeaturestoreServiceClient featurestoreServiceClient = FeaturestoreServiceClient.create()) {
   GetEntityTypeRequest request =
       GetEntityTypeRequest.newBuilder()
           .setName(
               EntityTypeName.of("[PROJECT]", "[LOCATION]", "[FEATURESTORE]", "[ENTITY_TYPE]")
                   .toString())
           .build();
   EntityType response = featurestoreServiceClient.getEntityType(request);
 }
Parameter
Name Description
request GetEntityTypeRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
EntityType

getEntityType(String name)

public final EntityType getEntityType(String name)

Gets details of a single EntityType.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (FeaturestoreServiceClient featurestoreServiceClient = FeaturestoreServiceClient.create()) {
   String name =
       EntityTypeName.of("[PROJECT]", "[LOCATION]", "[FEATURESTORE]", "[ENTITY_TYPE]")
           .toString();
   EntityType response = featurestoreServiceClient.getEntityType(name);
 }
Parameter
Name Description
name String

Required. The name of the EntityType resource. Format: projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}
Returns
Type Description
EntityType

getEntityTypeCallable()

public final UnaryCallable<GetEntityTypeRequest,EntityType> getEntityTypeCallable()

Gets details of a single EntityType.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (FeaturestoreServiceClient featurestoreServiceClient = FeaturestoreServiceClient.create()) {
   GetEntityTypeRequest request =
       GetEntityTypeRequest.newBuilder()
           .setName(
               EntityTypeName.of("[PROJECT]", "[LOCATION]", "[FEATURESTORE]", "[ENTITY_TYPE]")
                   .toString())
           .build();
   ApiFuture<EntityType> future =
       featurestoreServiceClient.getEntityTypeCallable().futureCall(request);
   // Do something.
   EntityType response = future.get();
 }
Returns
Type Description
UnaryCallable<GetEntityTypeRequest,EntityType>

getFeature(FeatureName name)

public final Feature getFeature(FeatureName name)

Gets details of a single Feature.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (FeaturestoreServiceClient featurestoreServiceClient = FeaturestoreServiceClient.create()) {
   FeatureName name =
       FeatureName.ofProjectLocationFeaturestoreEntityTypeFeatureName(
           "[PROJECT]", "[LOCATION]", "[FEATURESTORE]", "[ENTITY_TYPE]", "[FEATURE]");
   Feature response = featurestoreServiceClient.getFeature(name);
 }
Parameter
Name Description
name FeatureName

Required. The name of the Feature resource. Format: projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type} projects/{project}/locations/{location}/featureGroups/{feature_group}
Returns
Type Description
Feature

getFeature(GetFeatureRequest request)

public final Feature