Enterprise Knowledge Graph v1 API - Class EnterpriseKnowledgeGraphServiceClientImpl (1.0.0-beta02)

Version 1.0.0-beta02

• 1.0.0-beta04 (latest)
• 1.0.0-beta03

public sealed class EnterpriseKnowledgeGraphServiceClientImpl : EnterpriseKnowledgeGraphServiceClient

Reference documentation and code samples for the Enterprise Knowledge Graph v1 API class EnterpriseKnowledgeGraphServiceClientImpl.

EnterpriseKnowledgeGraphService client wrapper implementation, for convenient use.

Inheritance

object > EnterpriseKnowledgeGraphServiceClient > EnterpriseKnowledgeGraphServiceClientImpl

Inherited Members

EnterpriseKnowledgeGraphServiceClient.DefaultEndpoint

EnterpriseKnowledgeGraphServiceClient.DefaultScopes

EnterpriseKnowledgeGraphServiceClient.ServiceMetadata

EnterpriseKnowledgeGraphServiceClient.CreateAsync(CancellationToken)

EnterpriseKnowledgeGraphServiceClient.Create()

EnterpriseKnowledgeGraphServiceClient.ShutdownDefaultChannelsAsync()

EnterpriseKnowledgeGraphServiceClient.CreateEntityReconciliationJobAsync(CreateEntityReconciliationJobRequest, CancellationToken)

EnterpriseKnowledgeGraphServiceClient.CreateEntityReconciliationJob(string, EntityReconciliationJob, CallSettings)

EnterpriseKnowledgeGraphServiceClient.CreateEntityReconciliationJobAsync(string, EntityReconciliationJob, CallSettings)

EnterpriseKnowledgeGraphServiceClient.CreateEntityReconciliationJobAsync(string, EntityReconciliationJob, CancellationToken)

EnterpriseKnowledgeGraphServiceClient.CreateEntityReconciliationJob(LocationName, EntityReconciliationJob, CallSettings)

EnterpriseKnowledgeGraphServiceClient.CreateEntityReconciliationJobAsync(LocationName, EntityReconciliationJob, CallSettings)

EnterpriseKnowledgeGraphServiceClient.CreateEntityReconciliationJobAsync(LocationName, EntityReconciliationJob, CancellationToken)

EnterpriseKnowledgeGraphServiceClient.GetEntityReconciliationJobAsync(GetEntityReconciliationJobRequest, CancellationToken)

EnterpriseKnowledgeGraphServiceClient.GetEntityReconciliationJob(string, CallSettings)

EnterpriseKnowledgeGraphServiceClient.GetEntityReconciliationJobAsync(string, CallSettings)

EnterpriseKnowledgeGraphServiceClient.GetEntityReconciliationJobAsync(string, CancellationToken)

EnterpriseKnowledgeGraphServiceClient.GetEntityReconciliationJob(EntityReconciliationJobName, CallSettings)

EnterpriseKnowledgeGraphServiceClient.GetEntityReconciliationJobAsync(EntityReconciliationJobName, CallSettings)

EnterpriseKnowledgeGraphServiceClient.GetEntityReconciliationJobAsync(EntityReconciliationJobName, CancellationToken)

EnterpriseKnowledgeGraphServiceClient.ListEntityReconciliationJobs(string, string, int?, CallSettings)

EnterpriseKnowledgeGraphServiceClient.ListEntityReconciliationJobsAsync(string, string, int?, CallSettings)

EnterpriseKnowledgeGraphServiceClient.ListEntityReconciliationJobs(LocationName, string, int?, CallSettings)

EnterpriseKnowledgeGraphServiceClient.ListEntityReconciliationJobsAsync(LocationName, string, int?, CallSettings)

EnterpriseKnowledgeGraphServiceClient.CancelEntityReconciliationJobAsync(CancelEntityReconciliationJobRequest, CancellationToken)

EnterpriseKnowledgeGraphServiceClient.CancelEntityReconciliationJob(string, CallSettings)

EnterpriseKnowledgeGraphServiceClient.CancelEntityReconciliationJobAsync(string, CallSettings)

EnterpriseKnowledgeGraphServiceClient.CancelEntityReconciliationJobAsync(string, CancellationToken)

EnterpriseKnowledgeGraphServiceClient.CancelEntityReconciliationJob(EntityReconciliationJobName, CallSettings)

EnterpriseKnowledgeGraphServiceClient.CancelEntityReconciliationJobAsync(EntityReconciliationJobName, CallSettings)

EnterpriseKnowledgeGraphServiceClient.CancelEntityReconciliationJobAsync(EntityReconciliationJobName, CancellationToken)

EnterpriseKnowledgeGraphServiceClient.DeleteEntityReconciliationJobAsync(DeleteEntityReconciliationJobRequest, CancellationToken)

EnterpriseKnowledgeGraphServiceClient.DeleteEntityReconciliationJob(string, CallSettings)

EnterpriseKnowledgeGraphServiceClient.DeleteEntityReconciliationJobAsync(string, CallSettings)

EnterpriseKnowledgeGraphServiceClient.DeleteEntityReconciliationJobAsync(string, CancellationToken)

EnterpriseKnowledgeGraphServiceClient.DeleteEntityReconciliationJob(EntityReconciliationJobName, CallSettings)

EnterpriseKnowledgeGraphServiceClient.DeleteEntityReconciliationJobAsync(EntityReconciliationJobName, CallSettings)

EnterpriseKnowledgeGraphServiceClient.DeleteEntityReconciliationJobAsync(EntityReconciliationJobName, CancellationToken)

EnterpriseKnowledgeGraphServiceClient.LookupAsync(LookupRequest, CancellationToken)

EnterpriseKnowledgeGraphServiceClient.Lookup(string, IEnumerable<string>, CallSettings)

EnterpriseKnowledgeGraphServiceClient.LookupAsync(string, IEnumerable<string>, CallSettings)

EnterpriseKnowledgeGraphServiceClient.LookupAsync(string, IEnumerable<string>, CancellationToken)

EnterpriseKnowledgeGraphServiceClient.Lookup(LocationName, IEnumerable<string>, CallSettings)

EnterpriseKnowledgeGraphServiceClient.LookupAsync(LocationName, IEnumerable<string>, CallSettings)

EnterpriseKnowledgeGraphServiceClient.LookupAsync(LocationName, IEnumerable<string>, CancellationToken)

EnterpriseKnowledgeGraphServiceClient.SearchAsync(SearchRequest, CancellationToken)

EnterpriseKnowledgeGraphServiceClient.Search(string, string, CallSettings)

EnterpriseKnowledgeGraphServiceClient.SearchAsync(string, string, CallSettings)

EnterpriseKnowledgeGraphServiceClient.SearchAsync(string, string, CancellationToken)

EnterpriseKnowledgeGraphServiceClient.Search(LocationName, string, CallSettings)

EnterpriseKnowledgeGraphServiceClient.SearchAsync(LocationName, string, CallSettings)

EnterpriseKnowledgeGraphServiceClient.SearchAsync(LocationName, string, CancellationToken)

EnterpriseKnowledgeGraphServiceClient.LookupPublicKgAsync(LookupPublicKgRequest, CancellationToken)

EnterpriseKnowledgeGraphServiceClient.LookupPublicKg(string, IEnumerable<string>, CallSettings)

EnterpriseKnowledgeGraphServiceClient.LookupPublicKgAsync(string, IEnumerable<string>, CallSettings)

EnterpriseKnowledgeGraphServiceClient.LookupPublicKgAsync(string, IEnumerable<string>, CancellationToken)

EnterpriseKnowledgeGraphServiceClient.LookupPublicKg(LocationName, IEnumerable<string>, CallSettings)

EnterpriseKnowledgeGraphServiceClient.LookupPublicKgAsync(LocationName, IEnumerable<string>, CallSettings)

EnterpriseKnowledgeGraphServiceClient.LookupPublicKgAsync(LocationName, IEnumerable<string>, CancellationToken)

EnterpriseKnowledgeGraphServiceClient.SearchPublicKgAsync(SearchPublicKgRequest, CancellationToken)

EnterpriseKnowledgeGraphServiceClient.SearchPublicKg(string, string, CallSettings)

EnterpriseKnowledgeGraphServiceClient.SearchPublicKgAsync(string, string, CallSettings)

EnterpriseKnowledgeGraphServiceClient.SearchPublicKgAsync(string, string, CancellationToken)

EnterpriseKnowledgeGraphServiceClient.SearchPublicKg(LocationName, string, CallSettings)

EnterpriseKnowledgeGraphServiceClient.SearchPublicKgAsync(LocationName, string, CallSettings)

EnterpriseKnowledgeGraphServiceClient.SearchPublicKgAsync(LocationName, string, CancellationToken)

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

Google.Cloud.EnterpriseKnowledgeGraph.V1

Assembly

Google.Cloud.EnterpriseKnowledgeGraph.V1.dll

Remarks

APIs for enterprise knowledge graph product.

Constructors

EnterpriseKnowledgeGraphServiceClientImpl(EnterpriseKnowledgeGraphServiceClient, EnterpriseKnowledgeGraphServiceSettings, ILogger)

public EnterpriseKnowledgeGraphServiceClientImpl(EnterpriseKnowledgeGraphService.EnterpriseKnowledgeGraphServiceClient grpcClient, EnterpriseKnowledgeGraphServiceSettings settings, ILogger logger)

Constructs a client wrapper for the EnterpriseKnowledgeGraphService service, with the specified gRPC client and settings.

Parameters
Name	Description
grpcClient	EnterpriseKnowledgeGraphServiceEnterpriseKnowledgeGraphServiceClient The underlying gRPC client.
settings	EnterpriseKnowledgeGraphServiceSettings The base EnterpriseKnowledgeGraphServiceSettings used within this client.
logger	ILogger Optional ILogger to use within this client.

Properties

GrpcClient

public override EnterpriseKnowledgeGraphService.EnterpriseKnowledgeGraphServiceClient GrpcClient { get; }

The underlying gRPC EnterpriseKnowledgeGraphService client

Property Value
Type	Description
EnterpriseKnowledgeGraphServiceEnterpriseKnowledgeGraphServiceClient

Overrides

EnterpriseKnowledgeGraphServiceClient.GrpcClient

Methods

CancelEntityReconciliationJob(CancelEntityReconciliationJobRequest, CallSettings)

public override void CancelEntityReconciliationJob(CancelEntityReconciliationJobRequest request, CallSettings callSettings = null)

Cancels a EntityReconciliationJob. Success of cancellation is not guaranteed.

Parameters
Name	Description
request	CancelEntityReconciliationJobRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Overrides

EnterpriseKnowledgeGraphServiceClient.CancelEntityReconciliationJob(CancelEntityReconciliationJobRequest, CallSettings)

CancelEntityReconciliationJobAsync(CancelEntityReconciliationJobRequest, CallSettings)

public override Task CancelEntityReconciliationJobAsync(CancelEntityReconciliationJobRequest request, CallSettings callSettings = null)

Cancels a EntityReconciliationJob. Success of cancellation is not guaranteed.

Parameters
Name	Description
request	CancelEntityReconciliationJobRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Task	A Task containing the RPC response.

Overrides

EnterpriseKnowledgeGraphServiceClient.CancelEntityReconciliationJobAsync(CancelEntityReconciliationJobRequest, CallSettings)

CreateEntityReconciliationJob(CreateEntityReconciliationJobRequest, CallSettings)

public override EntityReconciliationJob CreateEntityReconciliationJob(CreateEntityReconciliationJobRequest request, CallSettings callSettings = null)

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

Parameters
Name	Description
request	CreateEntityReconciliationJobRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
EntityReconciliationJob	The RPC response.

Overrides

EnterpriseKnowledgeGraphServiceClient.CreateEntityReconciliationJob(CreateEntityReconciliationJobRequest, CallSettings)

CreateEntityReconciliationJobAsync(CreateEntityReconciliationJobRequest, CallSettings)

public override Task<EntityReconciliationJob> CreateEntityReconciliationJobAsync(CreateEntityReconciliationJobRequest request, CallSettings callSettings = null)

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

Parameters
Name	Description
request	CreateEntityReconciliationJobRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskEntityReconciliationJob	A Task containing the RPC response.

Overrides

EnterpriseKnowledgeGraphServiceClient.CreateEntityReconciliationJobAsync(CreateEntityReconciliationJobRequest, CallSettings)

DeleteEntityReconciliationJob(DeleteEntityReconciliationJobRequest, CallSettings)

public override void DeleteEntityReconciliationJob(DeleteEntityReconciliationJobRequest request, CallSettings callSettings = null)

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

Parameters
Name	Description
request	DeleteEntityReconciliationJobRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Overrides

EnterpriseKnowledgeGraphServiceClient.DeleteEntityReconciliationJob(DeleteEntityReconciliationJobRequest, CallSettings)

DeleteEntityReconciliationJobAsync(DeleteEntityReconciliationJobRequest, CallSettings)

public override Task DeleteEntityReconciliationJobAsync(DeleteEntityReconciliationJobRequest request, CallSettings callSettings = null)

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

Parameters
Name	Description
request	DeleteEntityReconciliationJobRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Task	A Task containing the RPC response.

Overrides

EnterpriseKnowledgeGraphServiceClient.DeleteEntityReconciliationJobAsync(DeleteEntityReconciliationJobRequest, CallSettings)

GetEntityReconciliationJob(GetEntityReconciliationJobRequest, CallSettings)

public override EntityReconciliationJob GetEntityReconciliationJob(GetEntityReconciliationJobRequest request, CallSettings callSettings = null)

Gets a EntityReconciliationJob.

Parameters
Name	Description
request	GetEntityReconciliationJobRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
EntityReconciliationJob	The RPC response.

Overrides

EnterpriseKnowledgeGraphServiceClient.GetEntityReconciliationJob(GetEntityReconciliationJobRequest, CallSettings)

GetEntityReconciliationJobAsync(GetEntityReconciliationJobRequest, CallSettings)

public override Task<EntityReconciliationJob> GetEntityReconciliationJobAsync(GetEntityReconciliationJobRequest request, CallSettings callSettings = null)

Gets a EntityReconciliationJob.

Parameters
Name	Description
request	GetEntityReconciliationJobRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskEntityReconciliationJob	A Task containing the RPC response.

Overrides

EnterpriseKnowledgeGraphServiceClient.GetEntityReconciliationJobAsync(GetEntityReconciliationJobRequest, CallSettings)

ListEntityReconciliationJobs(ListEntityReconciliationJobsRequest, CallSettings)

public override PagedEnumerable<ListEntityReconciliationJobsResponse, EntityReconciliationJob> ListEntityReconciliationJobs(ListEntityReconciliationJobsRequest request, CallSettings callSettings = null)

Lists Entity Reconciliation Jobs.

Parameters
Name	Description
request	ListEntityReconciliationJobsRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
PagedEnumerableListEntityReconciliationJobsResponseEntityReconciliationJob	A pageable sequence of EntityReconciliationJob resources.

Overrides

EnterpriseKnowledgeGraphServiceClient.ListEntityReconciliationJobs(ListEntityReconciliationJobsRequest, CallSettings)

ListEntityReconciliationJobsAsync(ListEntityReconciliationJobsRequest, CallSettings)

public override PagedAsyncEnumerable<ListEntityReconciliationJobsResponse, EntityReconciliationJob> ListEntityReconciliationJobsAsync(ListEntityReconciliationJobsRequest request, CallSettings callSettings = null)

Lists Entity Reconciliation Jobs.

Parameters
Name	Description
request	ListEntityReconciliationJobsRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
PagedAsyncEnumerableListEntityReconciliationJobsResponseEntityReconciliationJob	A pageable asynchronous sequence of EntityReconciliationJob resources.

Overrides

EnterpriseKnowledgeGraphServiceClient.ListEntityReconciliationJobsAsync(ListEntityReconciliationJobsRequest, CallSettings)

Lookup(LookupRequest, CallSettings)

public override LookupResponse Lookup(LookupRequest request, CallSettings callSettings = null)

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

Parameters
Name	Description
request	LookupRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
LookupResponse	The RPC response.

Overrides

EnterpriseKnowledgeGraphServiceClient.Lookup(LookupRequest, CallSettings)

LookupAsync(LookupRequest, CallSettings)

public override Task<LookupResponse> LookupAsync(LookupRequest request, CallSettings callSettings = null)

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

Parameters
Name	Description
request	LookupRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskLookupResponse	A Task containing the RPC response.

Overrides

EnterpriseKnowledgeGraphServiceClient.LookupAsync(LookupRequest, CallSettings)

LookupPublicKg(LookupPublicKgRequest, CallSettings)

public override LookupPublicKgResponse LookupPublicKg(LookupPublicKgRequest request, CallSettings callSettings = null)

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

Parameters
Name	Description
request	LookupPublicKgRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
LookupPublicKgResponse	The RPC response.

Overrides

EnterpriseKnowledgeGraphServiceClient.LookupPublicKg(LookupPublicKgRequest, CallSettings)

LookupPublicKgAsync(LookupPublicKgRequest, CallSettings)

public override Task<LookupPublicKgResponse> LookupPublicKgAsync(LookupPublicKgRequest request, CallSettings callSettings = null)

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

Parameters
Name	Description
request	LookupPublicKgRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskLookupPublicKgResponse	A Task containing the RPC response.

Overrides

EnterpriseKnowledgeGraphServiceClient.LookupPublicKgAsync(LookupPublicKgRequest, CallSettings)

Search(SearchRequest, CallSettings)

public override SearchResponse Search(SearchRequest request, CallSettings callSettings = null)

Searches the Cloud KG entities with entity name.

Parameters
Name	Description
request	SearchRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
SearchResponse	The RPC response.

Overrides

EnterpriseKnowledgeGraphServiceClient.Search(SearchRequest, CallSettings)

SearchAsync(SearchRequest, CallSettings)

public override Task<SearchResponse> SearchAsync(SearchRequest request, CallSettings callSettings = null)

Searches the Cloud KG entities with entity name.

Parameters
Name	Description
request	SearchRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskSearchResponse	A Task containing the RPC response.

Overrides

EnterpriseKnowledgeGraphServiceClient.SearchAsync(SearchRequest, CallSettings)

SearchPublicKg(SearchPublicKgRequest, CallSettings)

public override SearchPublicKgResponse SearchPublicKg(SearchPublicKgRequest request, CallSettings callSettings = null)

Searches the public KG entities with entity name.

Parameters
Name	Description
request	SearchPublicKgRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
SearchPublicKgResponse	The RPC response.

Overrides

EnterpriseKnowledgeGraphServiceClient.SearchPublicKg(SearchPublicKgRequest, CallSettings)

SearchPublicKgAsync(SearchPublicKgRequest, CallSettings)

public override Task<SearchPublicKgResponse> SearchPublicKgAsync(SearchPublicKgRequest request, CallSettings callSettings = null)

Searches the public KG entities with entity name.

Parameters
Name	Description
request	SearchPublicKgRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskSearchPublicKgResponse	A Task containing the RPC response.

Overrides

EnterpriseKnowledgeGraphServiceClient.SearchPublicKgAsync(SearchPublicKgRequest, CallSettings)