Enterprise Knowledge Graph v1 API - Class EnterpriseKnowledgeGraphService.EnterpriseKnowledgeGraphServiceClient (1.0.0-beta02)

Version 1.0.0-beta02

• 1.0.0-beta04 (latest)
• 1.0.0-beta03

public class EnterpriseKnowledgeGraphService.EnterpriseKnowledgeGraphServiceClient : ClientBase<EnterpriseKnowledgeGraphService.EnterpriseKnowledgeGraphServiceClient>

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

Client for EnterpriseKnowledgeGraphService

Inheritance

object > ClientBase > ClientBaseEnterpriseKnowledgeGraphServiceEnterpriseKnowledgeGraphServiceClient > EnterpriseKnowledgeGraphService.EnterpriseKnowledgeGraphServiceClient

Inherited Members

ClientBase<EnterpriseKnowledgeGraphService.EnterpriseKnowledgeGraphServiceClient>.WithHost(string)

ClientBase.CallInvoker

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

Namespace

Google.Cloud.EnterpriseKnowledgeGraph.V1

Assembly

Google.Cloud.EnterpriseKnowledgeGraph.V1.dll

Constructors

EnterpriseKnowledgeGraphServiceClient()

protected EnterpriseKnowledgeGraphServiceClient()

Protected parameterless constructor to allow creation of test doubles.

EnterpriseKnowledgeGraphServiceClient(CallInvoker)

public EnterpriseKnowledgeGraphServiceClient(CallInvoker callInvoker)

Creates a new client for EnterpriseKnowledgeGraphService that uses a custom CallInvoker.

Parameter
Name	Description
callInvoker	CallInvoker The callInvoker to use to make remote calls.

EnterpriseKnowledgeGraphServiceClient(ChannelBase)

public EnterpriseKnowledgeGraphServiceClient(ChannelBase channel)

Creates a new client for EnterpriseKnowledgeGraphService

Parameter
Name	Description
channel	ChannelBase The channel to use to make remote calls.

EnterpriseKnowledgeGraphServiceClient(ClientBaseConfiguration)

protected EnterpriseKnowledgeGraphServiceClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
Name	Description
configuration	ClientBaseClientBaseConfiguration The client configuration.

Methods

CancelEntityReconciliationJob(CancelEntityReconciliationJobRequest, CallOptions)

public virtual Empty CancelEntityReconciliationJob(CancelEntityReconciliationJobRequest request, CallOptions options)

Cancels a EntityReconciliationJob. Success of cancellation is not guaranteed.

Parameters
Name	Description
request	CancelEntityReconciliationJobRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Empty	The response received from the server.

CancelEntityReconciliationJob(CancelEntityReconciliationJobRequest, Metadata, DateTime?, CancellationToken)

public virtual Empty CancelEntityReconciliationJob(CancelEntityReconciliationJobRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Cancels a EntityReconciliationJob. Success of cancellation is not guaranteed.

Parameters
Name	Description
request	CancelEntityReconciliationJobRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
Empty	The response received from the server.

CancelEntityReconciliationJobAsync(CancelEntityReconciliationJobRequest, CallOptions)

public virtual AsyncUnaryCall<Empty> CancelEntityReconciliationJobAsync(CancelEntityReconciliationJobRequest request, CallOptions options)

Cancels a EntityReconciliationJob. Success of cancellation is not guaranteed.

Parameters
Name	Description
request	CancelEntityReconciliationJobRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallEmpty	The call object.

CancelEntityReconciliationJobAsync(CancelEntityReconciliationJobRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Empty> CancelEntityReconciliationJobAsync(CancelEntityReconciliationJobRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Cancels a EntityReconciliationJob. Success of cancellation is not guaranteed.

Parameters
Name	Description
request	CancelEntityReconciliationJobRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallEmpty	The call object.

CreateEntityReconciliationJob(CreateEntityReconciliationJobRequest, CallOptions)

public virtual EntityReconciliationJob CreateEntityReconciliationJob(CreateEntityReconciliationJobRequest request, CallOptions options)

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

Parameters
Name	Description
request	CreateEntityReconciliationJobRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
EntityReconciliationJob	The response received from the server.

CreateEntityReconciliationJob(CreateEntityReconciliationJobRequest, Metadata, DateTime?, CancellationToken)

public virtual EntityReconciliationJob CreateEntityReconciliationJob(CreateEntityReconciliationJobRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
Name	Description
request	CreateEntityReconciliationJobRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
EntityReconciliationJob	The response received from the server.

CreateEntityReconciliationJobAsync(CreateEntityReconciliationJobRequest, CallOptions)

public virtual AsyncUnaryCall<EntityReconciliationJob> CreateEntityReconciliationJobAsync(CreateEntityReconciliationJobRequest request, CallOptions options)

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

Parameters
Name	Description
request	CreateEntityReconciliationJobRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallEntityReconciliationJob	The call object.

CreateEntityReconciliationJobAsync(CreateEntityReconciliationJobRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<EntityReconciliationJob> CreateEntityReconciliationJobAsync(CreateEntityReconciliationJobRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
Name	Description
request	CreateEntityReconciliationJobRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallEntityReconciliationJob	The call object.

DeleteEntityReconciliationJob(DeleteEntityReconciliationJobRequest, CallOptions)

public virtual Empty DeleteEntityReconciliationJob(DeleteEntityReconciliationJobRequest request, CallOptions options)

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 to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Empty	The response received from the server.

DeleteEntityReconciliationJob(DeleteEntityReconciliationJobRequest, Metadata, DateTime?, CancellationToken)

public virtual Empty DeleteEntityReconciliationJob(DeleteEntityReconciliationJobRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
Empty	The response received from the server.

DeleteEntityReconciliationJobAsync(DeleteEntityReconciliationJobRequest, CallOptions)

public virtual AsyncUnaryCall<Empty> DeleteEntityReconciliationJobAsync(DeleteEntityReconciliationJobRequest request, CallOptions options)

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 to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallEmpty	The call object.

DeleteEntityReconciliationJobAsync(DeleteEntityReconciliationJobRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Empty> DeleteEntityReconciliationJobAsync(DeleteEntityReconciliationJobRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallEmpty	The call object.

GetEntityReconciliationJob(GetEntityReconciliationJobRequest, CallOptions)

public virtual EntityReconciliationJob GetEntityReconciliationJob(GetEntityReconciliationJobRequest request, CallOptions options)

Gets a EntityReconciliationJob.

Parameters
Name	Description
request	GetEntityReconciliationJobRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
EntityReconciliationJob	The response received from the server.

GetEntityReconciliationJob(GetEntityReconciliationJobRequest, Metadata, DateTime?, CancellationToken)

public virtual EntityReconciliationJob GetEntityReconciliationJob(GetEntityReconciliationJobRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets a EntityReconciliationJob.

Parameters
Name	Description
request	GetEntityReconciliationJobRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
EntityReconciliationJob	The response received from the server.

GetEntityReconciliationJobAsync(GetEntityReconciliationJobRequest, CallOptions)

public virtual AsyncUnaryCall<EntityReconciliationJob> GetEntityReconciliationJobAsync(GetEntityReconciliationJobRequest request, CallOptions options)

Gets a EntityReconciliationJob.

Parameters
Name	Description
request	GetEntityReconciliationJobRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallEntityReconciliationJob	The call object.

GetEntityReconciliationJobAsync(GetEntityReconciliationJobRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<EntityReconciliationJob> GetEntityReconciliationJobAsync(GetEntityReconciliationJobRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets a EntityReconciliationJob.

Parameters
Name	Description
request	GetEntityReconciliationJobRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallEntityReconciliationJob	The call object.

ListEntityReconciliationJobs(ListEntityReconciliationJobsRequest, CallOptions)

public virtual ListEntityReconciliationJobsResponse ListEntityReconciliationJobs(ListEntityReconciliationJobsRequest request, CallOptions options)

Lists Entity Reconciliation Jobs.

Parameters
Name	Description
request	ListEntityReconciliationJobsRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
ListEntityReconciliationJobsResponse	The response received from the server.

ListEntityReconciliationJobs(ListEntityReconciliationJobsRequest, Metadata, DateTime?, CancellationToken)

public virtual ListEntityReconciliationJobsResponse ListEntityReconciliationJobs(ListEntityReconciliationJobsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists Entity Reconciliation Jobs.

Parameters
Name	Description
request	ListEntityReconciliationJobsRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
ListEntityReconciliationJobsResponse	The response received from the server.

ListEntityReconciliationJobsAsync(ListEntityReconciliationJobsRequest, CallOptions)

public virtual AsyncUnaryCall<ListEntityReconciliationJobsResponse> ListEntityReconciliationJobsAsync(ListEntityReconciliationJobsRequest request, CallOptions options)

Lists Entity Reconciliation Jobs.

Parameters
Name	Description
request	ListEntityReconciliationJobsRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallListEntityReconciliationJobsResponse	The call object.

ListEntityReconciliationJobsAsync(ListEntityReconciliationJobsRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ListEntityReconciliationJobsResponse> ListEntityReconciliationJobsAsync(ListEntityReconciliationJobsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists Entity Reconciliation Jobs.

Parameters
Name	Description
request	ListEntityReconciliationJobsRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallListEntityReconciliationJobsResponse	The call object.

Lookup(LookupRequest, CallOptions)

public virtual LookupResponse Lookup(LookupRequest request, CallOptions options)

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

Parameters
Name	Description
request	LookupRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
LookupResponse	The response received from the server.

Lookup(LookupRequest, Metadata, DateTime?, CancellationToken)

public virtual LookupResponse Lookup(LookupRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
Name	Description
request	LookupRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
LookupResponse	The response received from the server.

LookupAsync(LookupRequest, CallOptions)

public virtual AsyncUnaryCall<LookupResponse> LookupAsync(LookupRequest request, CallOptions options)

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

Parameters
Name	Description
request	LookupRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallLookupResponse	The call object.

LookupAsync(LookupRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<LookupResponse> LookupAsync(LookupRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
Name	Description
request	LookupRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallLookupResponse	The call object.

LookupPublicKg(LookupPublicKgRequest, CallOptions)

public virtual LookupPublicKgResponse LookupPublicKg(LookupPublicKgRequest request, CallOptions options)

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

Parameters
Name	Description
request	LookupPublicKgRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
LookupPublicKgResponse	The response received from the server.

LookupPublicKg(LookupPublicKgRequest, Metadata, DateTime?, CancellationToken)

public virtual LookupPublicKgResponse LookupPublicKg(LookupPublicKgRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
Name	Description
request	LookupPublicKgRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
LookupPublicKgResponse	The response received from the server.

LookupPublicKgAsync(LookupPublicKgRequest, CallOptions)

public virtual AsyncUnaryCall<LookupPublicKgResponse> LookupPublicKgAsync(LookupPublicKgRequest request, CallOptions options)

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

Parameters
Name	Description
request	LookupPublicKgRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallLookupPublicKgResponse	The call object.

LookupPublicKgAsync(LookupPublicKgRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<LookupPublicKgResponse> LookupPublicKgAsync(LookupPublicKgRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
Name	Description
request	LookupPublicKgRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallLookupPublicKgResponse	The call object.

NewInstance(ClientBaseConfiguration)

protected override EnterpriseKnowledgeGraphService.EnterpriseKnowledgeGraphServiceClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
Name	Description
configuration	ClientBaseClientBaseConfiguration

Returns
Type	Description
EnterpriseKnowledgeGraphServiceEnterpriseKnowledgeGraphServiceClient

Overrides

ClientBase<EnterpriseKnowledgeGraphService.EnterpriseKnowledgeGraphServiceClient>.NewInstance(ClientBase.ClientBaseConfiguration)

Search(SearchRequest, CallOptions)

public virtual SearchResponse Search(SearchRequest request, CallOptions options)

Searches the Cloud KG entities with entity name.

Parameters
Name	Description
request	SearchRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
SearchResponse	The response received from the server.

Search(SearchRequest, Metadata, DateTime?, CancellationToken)

public virtual SearchResponse Search(SearchRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Searches the Cloud KG entities with entity name.

Parameters
Name	Description
request	SearchRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
SearchResponse	The response received from the server.

SearchAsync(SearchRequest, CallOptions)

public virtual AsyncUnaryCall<SearchResponse> SearchAsync(SearchRequest request, CallOptions options)

Searches the Cloud KG entities with entity name.

Parameters
Name	Description
request	SearchRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallSearchResponse	The call object.

SearchAsync(SearchRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<SearchResponse> SearchAsync(SearchRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Searches the Cloud KG entities with entity name.

Parameters
Name	Description
request	SearchRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallSearchResponse	The call object.

SearchPublicKg(SearchPublicKgRequest, CallOptions)

public virtual SearchPublicKgResponse SearchPublicKg(SearchPublicKgRequest request, CallOptions options)

Searches the public KG entities with entity name.

Parameters
Name	Description
request	SearchPublicKgRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
SearchPublicKgResponse	The response received from the server.

SearchPublicKg(SearchPublicKgRequest, Metadata, DateTime?, CancellationToken)

public virtual SearchPublicKgResponse SearchPublicKg(SearchPublicKgRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Searches the public KG entities with entity name.

Parameters
Name	Description
request	SearchPublicKgRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
SearchPublicKgResponse	The response received from the server.

SearchPublicKgAsync(SearchPublicKgRequest, CallOptions)

public virtual AsyncUnaryCall<SearchPublicKgResponse> SearchPublicKgAsync(SearchPublicKgRequest request, CallOptions options)

Searches the public KG entities with entity name.

Parameters
Name	Description
request	SearchPublicKgRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallSearchPublicKgResponse	The call object.

SearchPublicKgAsync(SearchPublicKgRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<SearchPublicKgResponse> SearchPublicKgAsync(SearchPublicKgRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Searches the public KG entities with entity name.

Parameters
Name	Description
request	SearchPublicKgRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallSearchPublicKgResponse	The call object.