Package com.google.cloud.enterpriseknowledgegraph.v1 (0.19.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.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:

A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.

See the individual methods for example code.

Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.

This class can be customized by passing in a custom instance of 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.