Package com.google.cloud.enterpriseknowledgegraph.v1 (0.17.0)

A client to Enterprise Knowledge Graph API

The interfaces provided are listed below, along with usage samples.

EnterpriseKnowledgeGraphServiceClient

Service Description: APIs for enterprise knowledge graph product.

Sample for EnterpriseKnowledgeGraphServiceClient:


 // 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);
 }
 

Classes

AffinityClusteringConfig

Options for affinity clustering.

Protobuf type google.cloud.enterpriseknowledgegraph.v1.AffinityClusteringConfig

AffinityClusteringConfig.Builder

Options for affinity clustering.

Protobuf type google.cloud.enterpriseknowledgegraph.v1.AffinityClusteringConfig

BigQueryInputConfig

The input config for BigQuery tables.

Protobuf type google.cloud.enterpriseknowledgegraph.v1.BigQueryInputConfig

BigQueryInputConfig.Builder

The input config for BigQuery tables.

Protobuf type google.cloud.enterpriseknowledgegraph.v1.BigQueryInputConfig

CancelEntityReconciliationJobRequest

Request message for CancelEntityReconciliationJob.

Protobuf type google.cloud.enterpriseknowledgegraph.v1.CancelEntityReconciliationJobRequest

CancelEntityReconciliationJobRequest.Builder

Request message for CancelEntityReconciliationJob.

Protobuf type google.cloud.enterpriseknowledgegraph.v1.CancelEntityReconciliationJobRequest

CloudKnowledgeGraphEntityName

CloudKnowledgeGraphEntityName.Builder

Builder for projects/{project}/locations/{location}/cloudKnowledgeGraphEntities/{cloud_knowledge_graph_entity}.

CommonOperationMetadata

The common metadata for long running operations.

Protobuf type google.cloud.enterpriseknowledgegraph.v1.CommonOperationMetadata

CommonOperationMetadata.Builder

The common metadata for long running operations.

Protobuf type google.cloud.enterpriseknowledgegraph.v1.CommonOperationMetadata

ConnectedComponentsConfig

Options for connected components.

Protobuf type google.cloud.enterpriseknowledgegraph.v1.ConnectedComponentsConfig

ConnectedComponentsConfig.Builder

Options for connected components.

Protobuf type google.cloud.enterpriseknowledgegraph.v1.ConnectedComponentsConfig

CreateEntityReconciliationJobRequest

Request message for CreateEntityReconciliationJob.

Protobuf type google.cloud.enterpriseknowledgegraph.v1.CreateEntityReconciliationJobRequest

CreateEntityReconciliationJobRequest.Builder

Request message for CreateEntityReconciliationJob.

Protobuf type google.cloud.enterpriseknowledgegraph.v1.CreateEntityReconciliationJobRequest

DeleteEntityReconciliationJobRequest

Request message for DeleteEntityReconciliationJob.

Protobuf type google.cloud.enterpriseknowledgegraph.v1.DeleteEntityReconciliationJobRequest

DeleteEntityReconciliationJobRequest.Builder

Request message for DeleteEntityReconciliationJob.

Protobuf type google.cloud.enterpriseknowledgegraph.v1.DeleteEntityReconciliationJobRequest

DeleteOperationMetadata

Details of operations that perform deletes of any entities.

Protobuf type google.cloud.enterpriseknowledgegraph.v1.DeleteOperationMetadata

DeleteOperationMetadata.Builder

Details of operations that perform deletes of any entities.

Protobuf type google.cloud.enterpriseknowledgegraph.v1.DeleteOperationMetadata

EnterpriseKnowledgeGraphServiceClient

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().

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 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.

EnterpriseKnowledgeGraphServiceClient.ListEntityReconciliationJobsFixedSizeCollection

EnterpriseKnowledgeGraphServiceClient.ListEntityReconciliationJobsPage

EnterpriseKnowledgeGraphServiceClient.ListEntityReconciliationJobsPagedResponse

EnterpriseKnowledgeGraphServiceGrpc

APIs for enterprise knowledge graph product.

EnterpriseKnowledgeGraphServiceGrpc.EnterpriseKnowledgeGraphServiceBlockingStub

A stub to allow clients to do synchronous rpc calls to service EnterpriseKnowledgeGraphService.

APIs for enterprise knowledge graph product.

EnterpriseKnowledgeGraphServiceGrpc.EnterpriseKnowledgeGraphServiceFutureStub

A stub to allow clients to do ListenableFuture-style rpc calls to service EnterpriseKnowledgeGraphService.

APIs for enterprise knowledge graph product.

EnterpriseKnowledgeGraphServiceGrpc.EnterpriseKnowledgeGraphServiceImplBase

Base class for the server implementation of the service EnterpriseKnowledgeGraphService.

APIs for enterprise knowledge graph product.

EnterpriseKnowledgeGraphServiceGrpc.EnterpriseKnowledgeGraphServiceStub

A stub to allow clients to do asynchronous rpc calls to service EnterpriseKnowledgeGraphService.

APIs for enterprise knowledge graph product.

EnterpriseKnowledgeGraphServiceSettings

Settings class to configure an instance of EnterpriseKnowledgeGraphServiceClient.

The default instance has everything set to sensible defaults:

  • The default service address (enterpriseknowledgegraph.googleapis.com) and default port (443) are used.
  • Credentials are acquired automatically through Application Default Credentials.
  • Retries are configured for idempotent methods but not for non-idempotent methods.

The builder of this class is recursive, so contained classes are themselves builders. When build() is called, the tree of builders is called to create the complete settings object.

For example, to set the total timeout of createEntityReconciliationJob to 30 seconds:


 // 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.Builder enterpriseKnowledgeGraphServiceSettingsBuilder =
     EnterpriseKnowledgeGraphServiceSettings.newBuilder();
 enterpriseKnowledgeGraphServiceSettingsBuilder
     .createEntityReconciliationJobSettings()
     .setRetrySettings(
         enterpriseKnowledgeGraphServiceSettingsBuilder
             .createEntityReconciliationJobSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 EnterpriseKnowledgeGraphServiceSettings enterpriseKnowledgeGraphServiceSettings =
     enterpriseKnowledgeGraphServiceSettingsBuilder.build();
 

EnterpriseKnowledgeGraphServiceSettings.Builder

Builder for EnterpriseKnowledgeGraphServiceSettings.

EntityReconciliationJob

Entity reconciliation job message.

Protobuf type google.cloud.enterpriseknowledgegraph.v1.EntityReconciliationJob

EntityReconciliationJob.Builder

Entity reconciliation job message.

Protobuf type google.cloud.enterpriseknowledgegraph.v1.EntityReconciliationJob

EntityReconciliationJobName

EntityReconciliationJobName.Builder

Builder for projects/{project}/locations/{location}/entityReconciliationJobs/{entity_reconciliation_job}.

GetEntityReconciliationJobRequest

Request message for GetEntityReconciliationJob.

Protobuf type google.cloud.enterpriseknowledgegraph.v1.GetEntityReconciliationJobRequest

GetEntityReconciliationJobRequest.Builder

Request message for GetEntityReconciliationJob.

Protobuf type google.cloud.enterpriseknowledgegraph.v1.GetEntityReconciliationJobRequest

InputConfig

The desired input location and metadata.

Protobuf type google.cloud.enterpriseknowledgegraph.v1.InputConfig

InputConfig.Builder

The desired input location and metadata.

Protobuf type google.cloud.enterpriseknowledgegraph.v1.InputConfig

JobStateProto

ListEntityReconciliationJobsRequest

Request message for EnterpriseKnowledgeGraphService.ListEntityReconciliationJobs.

Protobuf type google.cloud.enterpriseknowledgegraph.v1.ListEntityReconciliationJobsRequest

ListEntityReconciliationJobsRequest.Builder

Request message for EnterpriseKnowledgeGraphService.ListEntityReconciliationJobs.

Protobuf type google.cloud.enterpriseknowledgegraph.v1.ListEntityReconciliationJobsRequest

ListEntityReconciliationJobsResponse

Response message for EnterpriseKnowledgeGraphService.ListEntityReconciliationJobs.

Protobuf type google.cloud.enterpriseknowledgegraph.v1.ListEntityReconciliationJobsResponse

ListEntityReconciliationJobsResponse.Builder

Response message for EnterpriseKnowledgeGraphService.ListEntityReconciliationJobs.

Protobuf type google.cloud.enterpriseknowledgegraph.v1.ListEntityReconciliationJobsResponse

LocationName

LocationName.Builder

Builder for projects/{project}/locations/{location}.

LookupPublicKgRequest

Request message for EnterpriseKnowledgeGraphService.LookupPublicKg.

Protobuf type google.cloud.enterpriseknowledgegraph.v1.LookupPublicKgRequest

LookupPublicKgRequest.Builder

Request message for EnterpriseKnowledgeGraphService.LookupPublicKg.

Protobuf type google.cloud.enterpriseknowledgegraph.v1.LookupPublicKgRequest

LookupPublicKgResponse

Response message for EnterpriseKnowledgeGraphService.LookupPublicKg.

Protobuf type google.cloud.enterpriseknowledgegraph.v1.LookupPublicKgResponse

LookupPublicKgResponse.Builder

Response message for EnterpriseKnowledgeGraphService.LookupPublicKg.

Protobuf type google.cloud.enterpriseknowledgegraph.v1.LookupPublicKgResponse

LookupRequest

Request message for EnterpriseKnowledgeGraphService.Lookup.

Protobuf type google.cloud.enterpriseknowledgegraph.v1.LookupRequest

LookupRequest.Builder

Request message for EnterpriseKnowledgeGraphService.Lookup.

Protobuf type google.cloud.enterpriseknowledgegraph.v1.LookupRequest

LookupResponse

Response message for EnterpriseKnowledgeGraphService.Lookup.

Protobuf type google.cloud.enterpriseknowledgegraph.v1.LookupResponse

LookupResponse.Builder

Response message for EnterpriseKnowledgeGraphService.Lookup.

Protobuf type google.cloud.enterpriseknowledgegraph.v1.LookupResponse

OperationMetadataProto

OutputConfig

The desired output location and metadata.

Protobuf type google.cloud.enterpriseknowledgegraph.v1.OutputConfig

OutputConfig.Builder

The desired output location and metadata.

Protobuf type google.cloud.enterpriseknowledgegraph.v1.OutputConfig

PublicKnowledgeGraphEntityName

PublicKnowledgeGraphEntityName.Builder

Builder for projects/{project}/locations/{location}/publicKnowledgeGraphEntities/{public_knowledge_graph_entity}.

ReconConfig

Recon configs

Protobuf type google.cloud.enterpriseknowledgegraph.v1.ReconConfig

ReconConfig.Builder

Recon configs

Protobuf type google.cloud.enterpriseknowledgegraph.v1.ReconConfig

ReconConfig.ModelConfig

Model Configs

Protobuf type google.cloud.enterpriseknowledgegraph.v1.ReconConfig.ModelConfig

ReconConfig.ModelConfig.Builder

Model Configs

Protobuf type google.cloud.enterpriseknowledgegraph.v1.ReconConfig.ModelConfig

ReconConfig.Options

Options for experimental changes on entity clustering behavior.

Protobuf type google.cloud.enterpriseknowledgegraph.v1.ReconConfig.Options

ReconConfig.Options.Builder

Options for experimental changes on entity clustering behavior.

Protobuf type google.cloud.enterpriseknowledgegraph.v1.ReconConfig.Options

SearchPublicKgRequest

Request message for EnterpriseKnowledgeGraphService.Search.

Protobuf type google.cloud.enterpriseknowledgegraph.v1.SearchPublicKgRequest

SearchPublicKgRequest.Builder

Request message for EnterpriseKnowledgeGraphService.Search.

Protobuf type google.cloud.enterpriseknowledgegraph.v1.SearchPublicKgRequest

SearchPublicKgResponse

Response message for EnterpriseKnowledgeGraphService.Search.

Protobuf type google.cloud.enterpriseknowledgegraph.v1.SearchPublicKgResponse

SearchPublicKgResponse.Builder

Response message for EnterpriseKnowledgeGraphService.Search.

Protobuf type google.cloud.enterpriseknowledgegraph.v1.SearchPublicKgResponse

SearchRequest

Request message for EnterpriseKnowledgeGraphService.Search.

Protobuf type google.cloud.enterpriseknowledgegraph.v1.SearchRequest

SearchRequest.Builder

Request message for EnterpriseKnowledgeGraphService.Search.

Protobuf type google.cloud.enterpriseknowledgegraph.v1.SearchRequest

SearchResponse

Response message for EnterpriseKnowledgeGraphService.Search.

Protobuf type google.cloud.enterpriseknowledgegraph.v1.SearchResponse

SearchResponse.Builder

Response message for EnterpriseKnowledgeGraphService.Search.

Protobuf type google.cloud.enterpriseknowledgegraph.v1.SearchResponse

ServiceProto

Interfaces

AffinityClusteringConfigOrBuilder

BigQueryInputConfigOrBuilder

CancelEntityReconciliationJobRequestOrBuilder

CommonOperationMetadataOrBuilder

ConnectedComponentsConfigOrBuilder

CreateEntityReconciliationJobRequestOrBuilder

DeleteEntityReconciliationJobRequestOrBuilder

DeleteOperationMetadataOrBuilder

EnterpriseKnowledgeGraphServiceGrpc.AsyncService

APIs for enterprise knowledge graph product.

EntityReconciliationJobOrBuilder

GetEntityReconciliationJobRequestOrBuilder

InputConfigOrBuilder

ListEntityReconciliationJobsRequestOrBuilder

ListEntityReconciliationJobsResponseOrBuilder

LookupPublicKgRequestOrBuilder

LookupPublicKgResponseOrBuilder

LookupRequestOrBuilder

LookupResponseOrBuilder

OutputConfigOrBuilder

ReconConfig.ModelConfigOrBuilder

ReconConfig.OptionsOrBuilder

ReconConfigOrBuilder

SearchPublicKgRequestOrBuilder

SearchPublicKgResponseOrBuilder

SearchRequestOrBuilder

SearchResponseOrBuilder

Enums

CommonOperationMetadata.State

State of the longrunning operation.

Protobuf enum google.cloud.enterpriseknowledgegraph.v1.CommonOperationMetadata.State

InputConfig.EntityType

The type of entities we will support. Currently, we only support people, establishment, property, and product types. If the type is unspecified, it will be generic type.

Protobuf enum google.cloud.enterpriseknowledgegraph.v1.InputConfig.EntityType

JobState

Describes the state of a job.

Protobuf enum google.cloud.enterpriseknowledgegraph.v1.JobState

ReconConfig.ClusteringConfigCase