Class EnterpriseKnowledgeGraphServiceClient (0.44.0)

GitHub RepositoryProduct Reference

Service Description: APIs for enterprise knowledge graph product.

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 (EnterpriseKnowledgeGraphServiceClient enterpriseKnowledgeGraphServiceClient =
     EnterpriseKnowledgeGraphServiceClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   EntityReconciliationJob entityReconciliationJob =
       EntityReconciliationJob.newBuilder().build();
   EntityReconciliationJob response =
       enterpriseKnowledgeGraphServiceClient.createEntityReconciliationJob(
           parent, entityReconciliationJob);
 }

Note: close() needs to be called on the EnterpriseKnowledgeGraphServiceClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().

Methods
Method Description Method Variants

CreateEntityReconciliationJob

Creates a EntityReconciliationJob. A EntityReconciliationJob once created will right away be attempted to start.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • createEntityReconciliationJob(CreateEntityReconciliationJobRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • createEntityReconciliationJob(LocationName parent, EntityReconciliationJob entityReconciliationJob)

  • createEntityReconciliationJob(String parent, EntityReconciliationJob entityReconciliationJob)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • createEntityReconciliationJobCallable()

GetEntityReconciliationJob

Gets a EntityReconciliationJob.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • getEntityReconciliationJob(GetEntityReconciliationJobRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • getEntityReconciliationJob(EntityReconciliationJobName name)

  • getEntityReconciliationJob(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • getEntityReconciliationJobCallable()

ListEntityReconciliationJobs

Lists Entity Reconciliation Jobs.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • listEntityReconciliationJobs(ListEntityReconciliationJobsRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • listEntityReconciliationJobs(LocationName parent)

  • listEntityReconciliationJobs(String parent)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • listEntityReconciliationJobsPagedCallable()

  • listEntityReconciliationJobsCallable()

CancelEntityReconciliationJob

Cancels a EntityReconciliationJob. Success of cancellation is not guaranteed.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • cancelEntityReconciliationJob(CancelEntityReconciliationJobRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • cancelEntityReconciliationJob(EntityReconciliationJobName name)

  • cancelEntityReconciliationJob(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • cancelEntityReconciliationJobCallable()

DeleteEntityReconciliationJob

Deletes a EntityReconciliationJob. It only deletes the job when the job state is in FAILED, SUCCEEDED, and CANCELLED.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • deleteEntityReconciliationJob(DeleteEntityReconciliationJobRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • deleteEntityReconciliationJob(EntityReconciliationJobName name)

  • deleteEntityReconciliationJob(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • deleteEntityReconciliationJobCallable()

Lookup

Finds the Cloud KG entities with CKG ID(s).

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • lookup(LookupRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • lookup(LocationName parent, List<String> ids)

  • lookup(String parent, List<String> ids)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • lookupCallable()

Search

Searches the Cloud KG entities with entity name.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • search(SearchRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • search(LocationName parent, String query)

  • search(String parent, String query)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • searchCallable()

LookupPublicKg

Finds the public KG entities with public KG ID(s).

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • lookupPublicKg(LookupPublicKgRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • lookupPublicKg(LocationName parent, List<String> ids)

  • lookupPublicKg(String parent, List<String> ids)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • lookupPublicKgCallable()

SearchPublicKg

Searches the public KG entities with entity name.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • searchPublicKg(SearchPublicKgRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • searchPublicKg(LocationName parent, String query)

  • searchPublicKg(String parent, String query)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • searchPublicKgCallable()

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 EnterpriseKnowledgeGraphServiceSettings 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
 EnterpriseKnowledgeGraphServiceSettings enterpriseKnowledgeGraphServiceSettings =
     EnterpriseKnowledgeGraphServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 EnterpriseKnowledgeGraphServiceClient enterpriseKnowledgeGraphServiceClient =
     EnterpriseKnowledgeGraphServiceClient.create(enterpriseKnowledgeGraphServiceSettings);

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
 EnterpriseKnowledgeGraphServiceSettings enterpriseKnowledgeGraphServiceSettings =
     EnterpriseKnowledgeGraphServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 EnterpriseKnowledgeGraphServiceClient enterpriseKnowledgeGraphServiceClient =
     EnterpriseKnowledgeGraphServiceClient.create(enterpriseKnowledgeGraphServiceSettings);

To use REST (HTTP1.1/JSON) transport (instead of gRPC) for sending and receiving requests over the wire:


 // 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
 EnterpriseKnowledgeGraphServiceSettings enterpriseKnowledgeGraphServiceSettings =
     EnterpriseKnowledgeGraphServiceSettings.newHttpJsonBuilder().build();
 EnterpriseKnowledgeGraphServiceClient enterpriseKnowledgeGraphServiceClient =
     EnterpriseKnowledgeGraphServiceClient.create(enterpriseKnowledgeGraphServiceSettings);

Please refer to the GitHub repository's samples for more quickstart code snippets.

Inheritance

java.lang.Object > EnterpriseKnowledgeGraphServiceClient

Static Methods

create()

public static final EnterpriseKnowledgeGraphServiceClient create()

Constructs an instance of EnterpriseKnowledgeGraphServiceClient with default settings.

Returns
Type Description
EnterpriseKnowledgeGraphServiceClient
Exceptions
Type Description
IOException

create(EnterpriseKnowledgeGraphServiceSettings settings)

public static final EnterpriseKnowledgeGraphServiceClient create(EnterpriseKnowledgeGraphServiceSettings settings)

Constructs an instance of EnterpriseKnowledgeGraphServiceClient, 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 EnterpriseKnowledgeGraphServiceSettings
Returns
Type Description
EnterpriseKnowledgeGraphServiceClient
Exceptions
Type Description
IOException

create(EnterpriseKnowledgeGraphServiceStub stub)

public static final EnterpriseKnowledgeGraphServiceClient create(EnterpriseKnowledgeGraphServiceStub stub)

Constructs an instance of EnterpriseKnowledgeGraphServiceClient, using the given stub for making calls. This is for advanced usage - prefer using create(EnterpriseKnowledgeGraphServiceSettings).

Parameter
Name Description
stub EnterpriseKnowledgeGraphServiceStub
Returns
Type Description
EnterpriseKnowledgeGraphServiceClient

Constructors

EnterpriseKnowledgeGraphServiceClient(EnterpriseKnowledgeGraphServiceSettings settings)

protected EnterpriseKnowledgeGraphServiceClient(EnterpriseKnowledgeGraphServiceSettings settings)

Constructs an instance of EnterpriseKnowledgeGraphServiceClient, 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 EnterpriseKnowledgeGraphServiceSettings

EnterpriseKnowledgeGraphServiceClient(EnterpriseKnowledgeGraphServiceStub stub)

protected EnterpriseKnowledgeGraphServiceClient(EnterpriseKnowledgeGraphServiceStub stub)
Parameter
Name Description
stub EnterpriseKnowledgeGraphServiceStub

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

cancelEntityReconciliationJob(CancelEntityReconciliationJobRequest request)

public final void cancelEntityReconciliationJob(CancelEntityReconciliationJobRequest request)

Cancels a EntityReconciliationJob. Success of cancellation is not guaranteed.

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 (EnterpriseKnowledgeGraphServiceClient enterpriseKnowledgeGraphServiceClient =
     EnterpriseKnowledgeGraphServiceClient.create()) {
   CancelEntityReconciliationJobRequest request =
       CancelEntityReconciliationJobRequest.newBuilder()
           .setName(
               EntityReconciliationJobName.of(
                       "[PROJECT]", "[LOCATION]", "[ENTITY_RECONCILIATION_JOB]")
                   .toString())
           .build();
   enterpriseKnowledgeGraphServiceClient.cancelEntityReconciliationJob(request);
 }
Parameter
Name Description
request CancelEntityReconciliationJobRequest

The request object containing all of the parameters for the API call.

cancelEntityReconciliationJob(EntityReconciliationJobName name)

public final void cancelEntityReconciliationJob(EntityReconciliationJobName name)

Cancels a EntityReconciliationJob. Success of cancellation is not guaranteed.

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 (EnterpriseKnowledgeGraphServiceClient enterpriseKnowledgeGraphServiceClient =
     EnterpriseKnowledgeGraphServiceClient.create()) {
   EntityReconciliationJobName name =
       EntityReconciliationJobName.of("[PROJECT]", "[LOCATION]", "[ENTITY_RECONCILIATION_JOB]");
   enterpriseKnowledgeGraphServiceClient.cancelEntityReconciliationJob(name);
 }
Parameter
Name Description
name EntityReconciliationJobName

Required. The name of the EntityReconciliationJob resource. Format: projects/{project}/locations/{location}/entityReconciliationJobs/{entity_reconciliation_job}

cancelEntityReconciliationJob(String name)

public final void cancelEntityReconciliationJob(String name)

Cancels a EntityReconciliationJob. Success of cancellation is not guaranteed.

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 (EnterpriseKnowledgeGraphServiceClient enterpriseKnowledgeGraphServiceClient =
     EnterpriseKnowledgeGraphServiceClient.create()) {
   String name =
       EntityReconciliationJobName.of("[PROJECT]", "[LOCATION]", "[ENTITY_RECONCILIATION_JOB]")
           .toString();
   enterpriseKnowledgeGraphServiceClient.cancelEntityReconciliationJob(name);
 }
Parameter
Name Description
name String

Required. The name of the EntityReconciliationJob resource. Format: projects/{project}/locations/{location}/entityReconciliationJobs/{entity_reconciliation_job}

cancelEntityReconciliationJobCallable()

public final UnaryCallable<CancelEntityReconciliationJobRequest,Empty> cancelEntityReconciliationJobCallable()

Cancels a EntityReconciliationJob. Success of cancellation is not guaranteed.

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 (EnterpriseKnowledgeGraphServiceClient enterpriseKnowledgeGraphServiceClient =
     EnterpriseKnowledgeGraphServiceClient.create()) {
   CancelEntityReconciliationJobRequest request =
       CancelEntityReconciliationJobRequest.newBuilder()
           .setName(
               EntityReconciliationJobName.of(
                       "[PROJECT]", "[LOCATION]", "[ENTITY_RECONCILIATION_JOB]")
                   .toString())
           .build();
   ApiFuture<Empty> future =
       enterpriseKnowledgeGraphServiceClient
           .cancelEntityReconciliationJobCallable()
           .futureCall(request);
   // Do something.
   future.get();
 }
Returns
Type Description
UnaryCallable<CancelEntityReconciliationJobRequest,Empty>

close()

public final void close()

createEntityReconciliationJob(CreateEntityReconciliationJobRequest request)

public final EntityReconciliationJob createEntityReconciliationJob(CreateEntityReconciliationJobRequest request)

Creates a EntityReconciliationJob. A EntityReconciliationJob once created will right away be attempted to start.

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 (EnterpriseKnowledgeGraphServiceClient enterpriseKnowledgeGraphServiceClient =
     EnterpriseKnowledgeGraphServiceClient.create()) {
   CreateEntityReconciliationJobRequest request =
       CreateEntityReconciliationJobRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setEntityReconciliationJob(EntityReconciliationJob.newBuilder().build())
           .build();
   EntityReconciliationJob response =
       enterpriseKnowledgeGraphServiceClient.createEntityReconciliationJob(request);
 }
Parameter
Name Description
request CreateEntityReconciliationJobRequest

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

createEntityReconciliationJob(LocationName parent, EntityReconciliationJob entityReconciliationJob)

public final EntityReconciliationJob createEntityReconciliationJob(LocationName parent, EntityReconciliationJob entityReconciliationJob)

Creates a EntityReconciliationJob. A EntityReconciliationJob once created will right away be attempted to start.

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 (EnterpriseKnowledgeGraphServiceClient enterpriseKnowledgeGraphServiceClient =
     EnterpriseKnowledgeGraphServiceClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   EntityReconciliationJob entityReconciliationJob =
       EntityReconciliationJob.newBuilder().build();
   EntityReconciliationJob response =
       enterpriseKnowledgeGraphServiceClient.createEntityReconciliationJob(
           parent, entityReconciliationJob);
 }
Parameters
Name Description
parent LocationName

Required. The resource name of the Location to create the EntityReconciliationJob in. Format: projects/{project}/locations/{location}
entityReconciliationJob EntityReconciliationJob

Required. The EntityReconciliationJob to create.
Returns
Type Description
EntityReconciliationJob

createEntityReconciliationJob(String parent, EntityReconciliationJob entityReconciliationJob)

public final EntityReconciliationJob createEntityReconciliationJob(String parent, EntityReconciliationJob entityReconciliationJob)

Creates a EntityReconciliationJob. A EntityReconciliationJob once created will right away be attempted to start.

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 (EnterpriseKnowledgeGraphServiceClient enterpriseKnowledgeGraphServiceClient =
     EnterpriseKnowledgeGraphServiceClient.create()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   EntityReconciliationJob entityReconciliationJob =
       EntityReconciliationJob.newBuilder().build();
   EntityReconciliationJob response =
       enterpriseKnowledgeGraphServiceClient.createEntityReconciliationJob(
           parent, entityReconciliationJob);
 }
Parameters
Name Description
parent String

Required. The resource name of the Location to create the EntityReconciliationJob in. Format: projects/{project}/locations/{location}
entityReconciliationJob EntityReconciliationJob

Required. The EntityReconciliationJob to create.
Returns
Type Description
EntityReconciliationJob

createEntityReconciliationJobCallable()

public final UnaryCallable<CreateEntityReconciliationJobRequest,EntityReconciliationJob> createEntityReconciliationJobCallable()

Creates a EntityReconciliationJob. A EntityReconciliationJob once created will right away be attempted to start.

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 (EnterpriseKnowledgeGraphServiceClient enterpriseKnowledgeGraphServiceClient =
     EnterpriseKnowledgeGraphServiceClient.create()) {
   CreateEntityReconciliationJobRequest request =
       CreateEntityReconciliationJobRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setEntityReconciliationJob(EntityReconciliationJob.newBuilder().build())
           .build();
   ApiFuture<EntityReconciliationJob> future =
       enterpriseKnowledgeGraphServiceClient
           .createEntityReconciliationJobCallable()
           .futureCall(request);
   // Do something.
   EntityReconciliationJob response = future.get();
 }
Returns
Type Description
UnaryCallable<CreateEntityReconciliationJobRequest,EntityReconciliationJob>

deleteEntityReconciliationJob(DeleteEntityReconciliationJobRequest request)

public final void deleteEntityReconciliationJob(DeleteEntityReconciliationJobRequest request)

Deletes a EntityReconciliationJob. It only deletes the job when the job state is in FAILED, SUCCEEDED, and CANCELLED.

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 (EnterpriseKnowledgeGraphServiceClient enterpriseKnowledgeGraphServiceClient =
     EnterpriseKnowledgeGraphServiceClient.create()) {
   DeleteEntityReconciliationJobRequest request =
       DeleteEntityReconciliationJobRequest.newBuilder()
           .setName(
               EntityReconciliationJobName.of(
                       "[PROJECT]", "[LOCATION]", "[ENTITY_RECONCILIATION_JOB]")
                   .toString())
           .build();
   enterpriseKnowledgeGraphServiceClient.deleteEntityReconciliationJob(request);
 }
Parameter
Name Description
request DeleteEntityReconciliationJobRequest

The request object containing all of the parameters for the API call.

deleteEntityReconciliationJob(EntityReconciliationJobName name)

public final void deleteEntityReconciliationJob(EntityReconciliationJobName name)

Deletes a EntityReconciliationJob. It only deletes the job when the job state is in FAILED, SUCCEEDED, and CANCELLED.

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 (EnterpriseKnowledgeGraphServiceClient enterpriseKnowledgeGraphServiceClient =
     EnterpriseKnowledgeGraphServiceClient.create()) {
   EntityReconciliationJobName name =
       EntityReconciliationJobName.of("[PROJECT]", "[LOCATION]", "[ENTITY_RECONCILIATION_JOB]");
   enterpriseKnowledgeGraphServiceClient.deleteEntityReconciliationJob(name);
 }
Parameter
Name Description
name EntityReconciliationJobName

Required. The name of the EntityReconciliationJob resource. Format: projects/{project}/locations/{location}/entityReconciliationJobs/{entity_reconciliation_job}

deleteEntityReconciliationJob(String name)

public final void deleteEntityReconciliationJob(String name)

Deletes a EntityReconciliationJob. It only deletes the job when the job state is in FAILED, SUCCEEDED, and CANCELLED.

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 (EnterpriseKnowledgeGraphServiceClient enterpriseKnowledgeGraphServiceClient =
     EnterpriseKnowledgeGraphServiceClient.create()) {
   String name =
       EntityReconciliationJobName.of("[PROJECT]", "[LOCATION]", "[ENTITY_RECONCILIATION_JOB]")
           .toString();
   enterpriseKnowledgeGraphServiceClient.deleteEntityReconciliationJob(name);
 }
Parameter
Name Description
name String

Required. The name of the EntityReconciliationJob resource. Format: projects/{project}/locations/{location}/entityReconciliationJobs/{entity_reconciliation_job}

deleteEntityReconciliationJobCallable()

public final UnaryCallable<DeleteEntityReconciliationJobRequest,Empty> deleteEntityReconciliationJobCallable()

Deletes a EntityReconciliationJob. It only deletes the job when the job state is in FAILED, SUCCEEDED, and CANCELLED.

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 (EnterpriseKnowledgeGraphServiceClient enterpriseKnowledgeGraphServiceClient =
     EnterpriseKnowledgeGraphServiceClient.create()) {
   DeleteEntityReconciliationJobRequest request =
       DeleteEntityReconciliationJobRequest.newBuilder()
           .setName(
               EntityReconciliationJobName.of(
                       "[PROJECT]", "[LOCATION]", "[ENTITY_RECONCILIATION_JOB]")
                   .toString())
           .build();
   ApiFuture<Empty> future =
       enterpriseKnowledgeGraphServiceClient
           .deleteEntityReconciliationJobCallable()
           .futureCall(request);
   // Do something.
   future.get();
 }
Returns
Type Description
UnaryCallable<DeleteEntityReconciliationJobRequest,Empty>

getEntityReconciliationJob(EntityReconciliationJobName name)

public final EntityReconciliationJob getEntityReconciliationJob(EntityReconciliationJobName name)

Gets a EntityReconciliationJob.

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 (EnterpriseKnowledgeGraphServiceClient enterpriseKnowledgeGraphServiceClient =
     EnterpriseKnowledgeGraphServiceClient.create()) {
   EntityReconciliationJobName name =
       EntityReconciliationJobName.of("[PROJECT]", "[LOCATION]", "[ENTITY_RECONCILIATION_JOB]");
   EntityReconciliationJob response =
       enterpriseKnowledgeGraphServiceClient.getEntityReconciliationJob(name);
 }
Parameter
Name Description
name EntityReconciliationJobName

Required. The name of the EntityReconciliationJob resource. Format: projects/{project}/locations/{location}/entityReconciliationJobs/{entity_reconciliation_job}
Returns
Type Description
EntityReconciliationJob

getEntityReconciliationJob(GetEntityReconciliationJobRequest request)

public final EntityReconciliationJob getEntityReconciliationJob(GetEntityReconciliationJobRequest request)

Gets a EntityReconciliationJob.

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 (EnterpriseKnowledgeGraphServiceClient enterpriseKnowledgeGraphServiceClient =
     EnterpriseKnowledgeGraphServiceClient.create()) {
   GetEntityReconciliationJobRequest request =
       GetEntityReconciliationJobRequest.newBuilder()
           .setName(
               EntityReconciliationJobName.of(
                       "[PROJECT]", "[LOCATION]", "[ENTITY_RECONCILIATION_JOB]")
                   .toString())
           .build();
   EntityReconciliationJob response =
       enterpriseKnowledgeGraphServiceClient.getEntityReconciliationJob(request);
 }
Parameter
Name Description
request GetEntityReconciliationJobRequest

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

getEntityReconciliationJob(String name)

public final EntityReconciliationJob getEntityReconciliationJob(String name)

Gets a EntityReconciliationJob.

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 (EnterpriseKnowledgeGraphServiceClient enterpriseKnowledgeGraphServiceClient =
     EnterpriseKnowledgeGraphServiceClient.create()) {
   String name =
       EntityReconciliationJobName.of("[PROJECT]", "[LOCATION]", "[ENTITY_RECONCILIATION_JOB]")
           .toString();
   EntityReconciliationJob response =
       enterpriseKnowledgeGraphServiceClient.getEntityReconciliationJob(name);
 }
Parameter
Name Description
name String

Required. The name of the EntityReconciliationJob resource. Format: projects/{project}/locations/{location}/entityReconciliationJobs/{entity_reconciliation_job}
Returns
Type Description
EntityReconciliationJob

getEntityReconciliationJobCallable()

public final UnaryCallable<GetEntityReconciliationJobRequest,EntityReconciliationJob> getEntityReconciliationJobCallable()

Gets a EntityReconciliationJob.

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 (EnterpriseKnowledgeGraphServiceClient enterpriseKnowledgeGraphServiceClient =
     EnterpriseKnowledgeGraphServiceClient.create()) {
   GetEntityReconciliationJobRequest request =
       GetEntityReconciliationJobRequest.newBuilder()
           .setName(
               EntityReconciliationJobName.of(
                       "[PROJECT]", "[LOCATION]", "[ENTITY_RECONCILIATION_JOB]")
                   .toString())
           .build();
   ApiFuture<EntityReconciliationJob> future =
       enterpriseKnowledgeGraphServiceClient
           .getEntityReconciliationJobCallable()
           .futureCall(request);
   // Do something.
   EntityReconciliationJob response = future.get();
 }
Returns
Type Description
UnaryCallable<GetEntityReconciliationJobRequest,EntityReconciliationJob>

getSettings()

public final EnterpriseKnowledgeGraphServiceSettings getSettings()
Returns
Type Description
EnterpriseKnowledgeGraphServiceSettings

getStub()

public EnterpriseKnowledgeGraphServiceStub getStub()
Returns
Type Description
EnterpriseKnowledgeGraphServiceStub

isShutdown()

public boolean isShutdown()
Returns
Type Description
boolean

isTerminated()

public boolean isTerminated()
Returns
Type Description
boolean

listEntityReconciliationJobs(ListEntityReconciliationJobsRequest request)

public final EnterpriseKnowledgeGraphServiceClient.ListEntityReconciliationJobsPagedResponse listEntityReconciliationJobs(ListEntityReconciliationJobsRequest request)

Lists Entity Reconciliation Jobs.

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 (EnterpriseKnowledgeGraphServiceClient enterpriseKnowledgeGraphServiceClient =
     EnterpriseKnowledgeGraphServiceClient.create()) {
   ListEntityReconciliationJobsRequest request =
       ListEntityReconciliationJobsRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (EntityReconciliationJob element :
       enterpriseKnowledgeGraphServiceClient
           .listEntityReconciliationJobs(request)
           .iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
request ListEntityReconciliationJobsRequest

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

listEntityReconciliationJobs(LocationName parent)

public final EnterpriseKnowledgeGraphServiceClient.ListEntityReconciliationJobsPagedResponse listEntityReconciliationJobs(LocationName parent)

Lists Entity Reconciliation Jobs.

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 (EnterpriseKnowledgeGraphServiceClient enterpriseKnowledgeGraphServiceClient =
     EnterpriseKnowledgeGraphServiceClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   for (EntityReconciliationJob element :
       enterpriseKnowledgeGraphServiceClient.listEntityReconciliationJobs(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
parent LocationName

Required. The name of the EntityReconciliationJob's parent resource. Format: projects/{project}/locations/{location}
Returns
Type Description
EnterpriseKnowledgeGraphServiceClient.ListEntityReconciliationJobsPagedResponse

listEntityReconciliationJobs(String parent)

public final EnterpriseKnowledgeGraphServiceClient.ListEntityReconciliationJobsPagedResponse listEntityReconciliationJobs(String parent)

Lists Entity Reconciliation Jobs.

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 (EnterpriseKnowledgeGraphServiceClient enterpriseKnowledgeGraphServiceClient =
     EnterpriseKnowledgeGraphServiceClient.create()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   for (EntityReconciliationJob element :
       enterpriseKnowledgeGraphServiceClient.listEntityReconciliationJobs(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
parent String

Required. The name of the EntityReconciliationJob's parent resource. Format: projects/{project}/locations/{location}
Returns
Type Description
EnterpriseKnowledgeGraphServiceClient.ListEntityReconciliationJobsPagedResponse

listEntityReconciliationJobsCallable()

public final UnaryCallable<ListEntityReconciliationJobsRequest,ListEntityReconciliationJobsResponse> listEntityReconciliationJobsCallable()

Lists Entity Reconciliation Jobs.

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 (EnterpriseKnowledgeGraphServiceClient enterpriseKnowledgeGraphServiceClient =
     EnterpriseKnowledgeGraphServiceClient.create()) {
   ListEntityReconciliationJobsRequest request =
       ListEntityReconciliationJobsRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListEntityReconciliationJobsResponse response =
         enterpriseKnowledgeGraphServiceClient
             .listEntityReconciliationJobsCallable()
             .call(request);
     for (EntityReconciliationJob element : response.getEntityReconciliationJobsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
Returns
Type Description
UnaryCallable<ListEntityReconciliationJobsRequest,ListEntityReconciliationJobsResponse>

listEntityReconciliationJobsPagedCallable()

public final UnaryCallable<ListEntityReconciliationJobsRequest,EnterpriseKnowledgeGraphServiceClient.ListEntityReconciliationJobsPagedResponse> listEntityReconciliationJobsPagedCallable()

Lists Entity Reconciliation Jobs.

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 (EnterpriseKnowledgeGraphServiceClient enterpriseKnowledgeGraphServiceClient =
     EnterpriseKnowledgeGraphServiceClient.create()) {
   ListEntityReconciliationJobsRequest request =
       ListEntityReconciliationJobsRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<EntityReconciliationJob> future =
       enterpriseKnowledgeGraphServiceClient
           .listEntityReconciliationJobsPagedCallable()
           .futureCall(request);
   // Do something.
   for (EntityReconciliationJob element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
Returns
Type Description
UnaryCallable<ListEntityReconciliationJobsRequest,ListEntityReconciliationJobsPagedResponse>

lookup(LocationName parent, List<String> ids)

public final LookupResponse lookup(LocationName parent, List<String> ids)

Finds the Cloud KG entities with CKG ID(s).

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 (EnterpriseKnowledgeGraphServiceClient enterpriseKnowledgeGraphServiceClient =
     EnterpriseKnowledgeGraphServiceClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   List<String> ids = new ArrayList<>();
   LookupResponse response = enterpriseKnowledgeGraphServiceClient.lookup(parent, ids);
 }
Parameters
Name Description
parent LocationName

Required. The name of the Entity's parent resource. Format: projects/{project}/locations/{location}
ids List<String>

Required. The list of entity ids to be used for lookup.
Returns
Type Description
LookupResponse

lookup(LookupRequest request)

public final LookupResponse lookup(LookupRequest request)

Finds the Cloud KG entities with CKG ID(s).

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 (EnterpriseKnowledgeGraphServiceClient enterpriseKnowledgeGraphServiceClient =
     EnterpriseKnowledgeGraphServiceClient.create()) {
   LookupRequest request =
       LookupRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .addAllIds(new ArrayList<String>())
           .addAllLanguages(new ArrayList<String>())
           .build();
   LookupResponse response = enterpriseKnowledgeGraphServiceClient.lookup(request);
 }
Parameter
Name Description
request LookupRequest

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

lookup(String parent, List<String> ids)

public final LookupResponse lookup(String parent, List<String> ids)

Finds the Cloud KG entities with CKG ID(s).

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 (EnterpriseKnowledgeGraphServiceClient enterpriseKnowledgeGraphServiceClient =
     EnterpriseKnowledgeGraphServiceClient.create()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   List<String> ids = new ArrayList<>();
   LookupResponse response = enterpriseKnowledgeGraphServiceClient.lookup(parent, ids);
 }
Parameters
Name Description
parent String

Required. The name of the Entity's parent resource. Format: projects/{project}/locations/{location}
ids List<String>

Required. The list of entity ids to be used for lookup.
Returns
Type Description
LookupResponse

lookupCallable()

public final UnaryCallable<LookupRequest,LookupResponse> lookupCallable()

Finds the Cloud KG entities with CKG ID(s).

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 (EnterpriseKnowledgeGraphServiceClient enterpriseKnowledgeGraphServiceClient =
     EnterpriseKnowledgeGraphServiceClient.create()) {
   LookupRequest request =
       LookupRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .addAllIds(new ArrayList<String>())
           .addAllLanguages(new ArrayList<String>())
           .build();
   ApiFuture<LookupResponse> future =
       enterpriseKnowledgeGraphServiceClient.lookupCallable().futureCall(request);
   // Do something.
   LookupResponse response = future.get();
 }
Returns
Type Description
UnaryCallable<LookupRequest,LookupResponse>

lookupPublicKg(LocationName parent, List<String> ids)

public final LookupPublicKgResponse lookupPublicKg(LocationName parent, List<String> ids)

Finds the public KG entities with public KG ID(s).

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 (EnterpriseKnowledgeGraphServiceClient enterpriseKnowledgeGraphServiceClient =
     EnterpriseKnowledgeGraphServiceClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   List<String> ids = new ArrayList<>();
   LookupPublicKgResponse response =
       enterpriseKnowledgeGraphServiceClient.lookupPublicKg(parent, ids);
 }
Parameters
Name Description
parent LocationName

Required. The name of the Entity's parent resource. Format: projects/{project}/locations/{location}
ids List<String>

Required. The list of entity ids to be used for lookup.
Returns
Type Description
LookupPublicKgResponse

lookupPublicKg(LookupPublicKgRequest request)

public final LookupPublicKgResponse lookupPublicKg(LookupPublicKgRequest request)

Finds the public KG entities with public KG ID(s).

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 (EnterpriseKnowledgeGraphServiceClient enterpriseKnowledgeGraphServiceClient =
     EnterpriseKnowledgeGraphServiceClient.create()) {
   LookupPublicKgRequest request =
       LookupPublicKgRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .addAllIds(new ArrayList<String>())
           .addAllLanguages(new ArrayList<String>())
           .build();
   LookupPublicKgResponse response =
       enterpriseKnowledgeGraphServiceClient.lookupPublicKg(request);
 }
Parameter
Name Description
request LookupPublicKgRequest

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

lookupPublicKg(String parent, List<String> ids)

public final LookupPublicKgResponse lookupPublicKg(String parent, List<String> ids)

Finds the public KG entities with public KG ID(s).

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 (EnterpriseKnowledgeGraphServiceClient enterpriseKnowledgeGraphServiceClient =
     EnterpriseKnowledgeGraphServiceClient.create()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   List<String> ids = new ArrayList<>();
   LookupPublicKgResponse response =
       enterpriseKnowledgeGraphServiceClient.lookupPublicKg(parent, ids);
 }
Parameters
Name Description
parent String

Required. The name of the Entity's parent resource. Format: projects/{project}/locations/{location}
ids List<String>

Required. The list of entity ids to be used for lookup.
Returns
Type Description
LookupPublicKgResponse

lookupPublicKgCallable()

public final UnaryCallable<LookupPublicKgRequest,LookupPublicKgResponse> lookupPublicKgCallable()

Finds the public KG entities with public KG ID(s).

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 (EnterpriseKnowledgeGraphServiceClient enterpriseKnowledgeGraphServiceClient =
     EnterpriseKnowledgeGraphServiceClient.create()) {
   LookupPublicKgRequest request =
       LookupPublicKgRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .addAllIds(new ArrayList<String>())
           .addAllLanguages(new ArrayList<String>())
           .build();
   ApiFuture<LookupPublicKgResponse> future =
       enterpriseKnowledgeGraphServiceClient.lookupPublicKgCallable().futureCall(request);
   // Do something.
   LookupPublicKgResponse response = future.get();
 }
Returns
Type Description
UnaryCallable<LookupPublicKgRequest,LookupPublicKgResponse>

search(LocationName parent, String query)

public final SearchResponse search(LocationName parent, String query)

Searches the Cloud KG entities with entity name.

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 (EnterpriseKnowledgeGraphServiceClient enterpriseKnowledgeGraphServiceClient =
     EnterpriseKnowledgeGraphServiceClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   String query = "query107944136";
   SearchResponse response = enterpriseKnowledgeGraphServiceClient.search(parent, query);
 }
Parameters
Name Description
parent LocationName

Required. The name of the Entity's parent resource. Format: projects/{project}/locations/{location}
query String

Required. The literal query string for search.
Returns
Type Description
SearchResponse

search(SearchRequest request)

public final SearchResponse search(SearchRequest request)

Searches the Cloud KG entities with entity name.

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 (EnterpriseKnowledgeGraphServiceClient enterpriseKnowledgeGraphServiceClient =
     EnterpriseKnowledgeGraphServiceClient.create()) {
   SearchRequest request =
       SearchRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setQuery("query107944136")
           .addAllLanguages(new ArrayList<String>())
           .addAllTypes(new ArrayList<String>())
           .setLimit(Int32Value.newBuilder().build())
           .build();
   SearchResponse response = enterpriseKnowledgeGraphServiceClient.search(request);
 }
Parameter
Name Description
request SearchRequest

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

search(String parent, String query)

public final SearchResponse search(String parent, String query)

Searches the Cloud KG entities with entity name.

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 (EnterpriseKnowledgeGraphServiceClient enterpriseKnowledgeGraphServiceClient =
     EnterpriseKnowledgeGraphServiceClient.create()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   String query = "query107944136";
   SearchResponse response = enterpriseKnowledgeGraphServiceClient.search(parent, query);
 }
Parameters
Name Description
parent String

Required. The name of the Entity's parent resource. Format: projects/{project}/locations/{location}
query String

Required. The literal query string for search.
Returns
Type Description
SearchResponse

searchCallable()

public final UnaryCallable<SearchRequest,SearchResponse> searchCallable()

Searches the Cloud KG entities with entity name.

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 (EnterpriseKnowledgeGraphServiceClient enterpriseKnowledgeGraphServiceClient =
     EnterpriseKnowledgeGraphServiceClient.create()) {
   SearchRequest request =
       SearchRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setQuery("query107944136")
           .addAllLanguages(new ArrayList<String>())
           .addAllTypes(new ArrayList<String>())
           .setLimit(Int32Value.newBuilder().build())
           .build();
   ApiFuture<SearchResponse> future =
       enterpriseKnowledgeGraphServiceClient.searchCallable().futureCall(request);
   // Do something.
   SearchResponse response = future.get();
 }
Returns
Type Description
UnaryCallable<SearchRequest,SearchResponse>

searchPublicKg(LocationName parent, String query)

public final SearchPublicKgResponse searchPublicKg(LocationName parent, String query)

Searches the public KG entities with entity name.

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 (EnterpriseKnowledgeGraphServiceClient enterpriseKnowledgeGraphServiceClient =
     EnterpriseKnowledgeGraphServiceClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   String query = "query107944136";
   SearchPublicKgResponse response =
       enterpriseKnowledgeGraphServiceClient.searchPublicKg(parent, query);
 }
Parameters
Name Description
parent LocationName

Required. The name of the Entity's parent resource. Format: projects/{project}/locations/{location}
query String

Required. The literal query string for search.
Returns
Type Description
SearchPublicKgResponse

searchPublicKg(SearchPublicKgRequest request)

public final SearchPublicKgResponse searchPublicKg(SearchPublicKgRequest request)

Searches the public KG entities with entity name.

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 (EnterpriseKnowledgeGraphServiceClient enterpriseKnowledgeGraphServiceClient =
     EnterpriseKnowledgeGraphServiceClient.create()) {
   SearchPublicKgRequest request =
       SearchPublicKgRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setQuery("query107944136")
           .addAllLanguages(new ArrayList<String>())
           .addAllTypes(new ArrayList<String>())
           .setLimit(Int32Value.newBuilder().build())
           .build();
   SearchPublicKgResponse response =
       enterpriseKnowledgeGraphServiceClient.searchPublicKg(request);
 }
Parameter
Name Description
request SearchPublicKgRequest

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

searchPublicKg(String parent, String query)

public final SearchPublicKgResponse searchPublicKg(String parent, String query)

Searches the public KG entities with entity name.

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 (EnterpriseKnowledgeGraphServiceClient enterpriseKnowledgeGraphServiceClient =
     EnterpriseKnowledgeGraphServiceClient.create()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   String query = "query107944136";
   SearchPublicKgResponse response =
       enterpriseKnowledgeGraphServiceClient.searchPublicKg(parent, query);
 }
Parameters
Name Description
parent String

Required. The name of the Entity's parent resource. Format: projects/{project}/locations/{location}
query String

Required. The literal query string for search.
Returns
Type Description
SearchPublicKgResponse

searchPublicKgCallable()

public final UnaryCallable<SearchPublicKgRequest,SearchPublicKgResponse> searchPublicKgCallable()

Searches the public KG entities with entity name.

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 (EnterpriseKnowledgeGraphServiceClient enterpriseKnowledgeGraphServiceClient =
     EnterpriseKnowledgeGraphServiceClient.create()) {
   SearchPublicKgRequest request =
       SearchPublicKgRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setQuery("query107944136")
           .addAllLanguages(new ArrayList<String>())
           .addAllTypes(new ArrayList<String>())
           .setLimit(Int32Value.newBuilder().build())
           .build();
   ApiFuture<SearchPublicKgResponse> future =
       enterpriseKnowledgeGraphServiceClient.searchPublicKgCallable().futureCall(request);
   // Do something.
   SearchPublicKgResponse response = future.get();
 }
Returns
Type Description
UnaryCallable<SearchPublicKgRequest,SearchPublicKgResponse>

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()