Enterprise Knowledge Graph v1 API - Class EnterpriseKnowledgeGraphServiceClient (1.0.0-beta04)

public abstract class EnterpriseKnowledgeGraphServiceClient

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

EnterpriseKnowledgeGraphService client wrapper, for convenient use.

Inheritance

object > EnterpriseKnowledgeGraphServiceClient

Namespace

Google.Cloud.EnterpriseKnowledgeGraph.V1

Assembly

Google.Cloud.EnterpriseKnowledgeGraph.V1.dll

Remarks

APIs for enterprise knowledge graph product.

Properties

DefaultEndpoint

public static string DefaultEndpoint { get; }

The default endpoint for the EnterpriseKnowledgeGraphService service, which is a host of "enterpriseknowledgegraph.googleapis.com" and a port of 443.

Property Value
Type Description
string

DefaultScopes

public static IReadOnlyList<string> DefaultScopes { get; }

The default EnterpriseKnowledgeGraphService scopes.

Property Value
Type Description
IReadOnlyListstring
Remarks

The default EnterpriseKnowledgeGraphService scopes are:

GrpcClient

public virtual EnterpriseKnowledgeGraphService.EnterpriseKnowledgeGraphServiceClient GrpcClient { get; }

The underlying gRPC EnterpriseKnowledgeGraphService client

Property Value
Type Description
EnterpriseKnowledgeGraphServiceEnterpriseKnowledgeGraphServiceClient

ServiceMetadata

public static ServiceMetadata ServiceMetadata { get; }

The service metadata associated with this client type.

Property Value
Type Description
ServiceMetadata

Methods

CancelEntityReconciliationJob(CancelEntityReconciliationJobRequest, CallSettings)

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

Example
// Create client
EnterpriseKnowledgeGraphServiceClient enterpriseKnowledgeGraphServiceClient = EnterpriseKnowledgeGraphServiceClient.Create();
// Initialize request argument(s)
CancelEntityReconciliationJobRequest request = new CancelEntityReconciliationJobRequest
{
    EntityReconciliationJobName = EntityReconciliationJobName.FromProjectLocationEntityReconciliationJob("[PROJECT]", "[LOCATION]", "[ENTITY_RECONCILIATION_JOB]"),
};
// Make the request
enterpriseKnowledgeGraphServiceClient.CancelEntityReconciliationJob(request);

CancelEntityReconciliationJob(EntityReconciliationJobName, CallSettings)

public virtual void CancelEntityReconciliationJob(EntityReconciliationJobName name, CallSettings callSettings = null)

Cancels a EntityReconciliationJob. Success of cancellation is not guaranteed.

Parameters
Name Description
name EntityReconciliationJobName

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Example
// Create client
EnterpriseKnowledgeGraphServiceClient enterpriseKnowledgeGraphServiceClient = EnterpriseKnowledgeGraphServiceClient.Create();
// Initialize request argument(s)
EntityReconciliationJobName name = EntityReconciliationJobName.FromProjectLocationEntityReconciliationJob("[PROJECT]", "[LOCATION]", "[ENTITY_RECONCILIATION_JOB]");
// Make the request
enterpriseKnowledgeGraphServiceClient.CancelEntityReconciliationJob(name);

CancelEntityReconciliationJob(string, CallSettings)

public virtual void CancelEntityReconciliationJob(string name, CallSettings callSettings = null)

Cancels a EntityReconciliationJob. Success of cancellation is not guaranteed.

Parameters
Name Description
name string

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Example
// Create client
EnterpriseKnowledgeGraphServiceClient enterpriseKnowledgeGraphServiceClient = EnterpriseKnowledgeGraphServiceClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/entityReconciliationJobs/[ENTITY_RECONCILIATION_JOB]";
// Make the request
enterpriseKnowledgeGraphServiceClient.CancelEntityReconciliationJob(name);

CancelEntityReconciliationJobAsync(CancelEntityReconciliationJobRequest, CallSettings)

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

Example
// Create client
EnterpriseKnowledgeGraphServiceClient enterpriseKnowledgeGraphServiceClient = await EnterpriseKnowledgeGraphServiceClient.CreateAsync();
// Initialize request argument(s)
CancelEntityReconciliationJobRequest request = new CancelEntityReconciliationJobRequest
{
    EntityReconciliationJobName = EntityReconciliationJobName.FromProjectLocationEntityReconciliationJob("[PROJECT]", "[LOCATION]", "[ENTITY_RECONCILIATION_JOB]"),
};
// Make the request
await enterpriseKnowledgeGraphServiceClient.CancelEntityReconciliationJobAsync(request);

CancelEntityReconciliationJobAsync(CancelEntityReconciliationJobRequest, CancellationToken)

public virtual Task CancelEntityReconciliationJobAsync(CancelEntityReconciliationJobRequest request, CancellationToken cancellationToken)

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.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
Task

A Task containing the RPC response.

Example
// Create client
EnterpriseKnowledgeGraphServiceClient enterpriseKnowledgeGraphServiceClient = await EnterpriseKnowledgeGraphServiceClient.CreateAsync();
// Initialize request argument(s)
CancelEntityReconciliationJobRequest request = new CancelEntityReconciliationJobRequest
{
    EntityReconciliationJobName = EntityReconciliationJobName.FromProjectLocationEntityReconciliationJob("[PROJECT]", "[LOCATION]", "[ENTITY_RECONCILIATION_JOB]"),
};
// Make the request
await enterpriseKnowledgeGraphServiceClient.CancelEntityReconciliationJobAsync(request);

CancelEntityReconciliationJobAsync(EntityReconciliationJobName, CallSettings)

public virtual Task CancelEntityReconciliationJobAsync(EntityReconciliationJobName name, CallSettings callSettings = null)

Cancels a EntityReconciliationJob. Success of cancellation is not guaranteed.

Parameters
Name Description
name EntityReconciliationJobName

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Task

A Task containing the RPC response.

Example
// Create client
EnterpriseKnowledgeGraphServiceClient enterpriseKnowledgeGraphServiceClient = await EnterpriseKnowledgeGraphServiceClient.CreateAsync();
// Initialize request argument(s)
EntityReconciliationJobName name = EntityReconciliationJobName.FromProjectLocationEntityReconciliationJob("[PROJECT]", "[LOCATION]", "[ENTITY_RECONCILIATION_JOB]");
// Make the request
await enterpriseKnowledgeGraphServiceClient.CancelEntityReconciliationJobAsync(name);

CancelEntityReconciliationJobAsync(EntityReconciliationJobName, CancellationToken)

public virtual Task CancelEntityReconciliationJobAsync(EntityReconciliationJobName name, CancellationToken cancellationToken)

Cancels a EntityReconciliationJob. Success of cancellation is not guaranteed.

Parameters
Name Description
name EntityReconciliationJobName

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

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
Task

A Task containing the RPC response.

Example
// Create client
EnterpriseKnowledgeGraphServiceClient enterpriseKnowledgeGraphServiceClient = await EnterpriseKnowledgeGraphServiceClient.CreateAsync();
// Initialize request argument(s)
EntityReconciliationJobName name = EntityReconciliationJobName.FromProjectLocationEntityReconciliationJob("[PROJECT]", "[LOCATION]", "[ENTITY_RECONCILIATION_JOB]");
// Make the request
await enterpriseKnowledgeGraphServiceClient.CancelEntityReconciliationJobAsync(name);

CancelEntityReconciliationJobAsync(string, CallSettings)

public virtual Task CancelEntityReconciliationJobAsync(string name, CallSettings callSettings = null)

Cancels a EntityReconciliationJob. Success of cancellation is not guaranteed.

Parameters
Name Description
name string

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Task

A Task containing the RPC response.

Example
// Create client
EnterpriseKnowledgeGraphServiceClient enterpriseKnowledgeGraphServiceClient = await EnterpriseKnowledgeGraphServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/entityReconciliationJobs/[ENTITY_RECONCILIATION_JOB]";
// Make the request
await enterpriseKnowledgeGraphServiceClient.CancelEntityReconciliationJobAsync(name);

CancelEntityReconciliationJobAsync(string, CancellationToken)

public virtual Task CancelEntityReconciliationJobAsync(string name, CancellationToken cancellationToken)

Cancels a EntityReconciliationJob. Success of cancellation is not guaranteed.

Parameters
Name Description
name string

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

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
Task

A Task containing the RPC response.

Example
// Create client
EnterpriseKnowledgeGraphServiceClient enterpriseKnowledgeGraphServiceClient = await EnterpriseKnowledgeGraphServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/entityReconciliationJobs/[ENTITY_RECONCILIATION_JOB]";
// Make the request
await enterpriseKnowledgeGraphServiceClient.CancelEntityReconciliationJobAsync(name);

Create()

public static EnterpriseKnowledgeGraphServiceClient Create()

Synchronously creates a EnterpriseKnowledgeGraphServiceClient using the default credentials, endpoint and settings. To specify custom credentials or other settings, use EnterpriseKnowledgeGraphServiceClientBuilder.

Returns
Type Description
EnterpriseKnowledgeGraphServiceClient

The created EnterpriseKnowledgeGraphServiceClient.

CreateAsync(CancellationToken)

public static Task<EnterpriseKnowledgeGraphServiceClient> CreateAsync(CancellationToken cancellationToken = default)

Asynchronously creates a EnterpriseKnowledgeGraphServiceClient using the default credentials, endpoint and settings. To specify custom credentials or other settings, use EnterpriseKnowledgeGraphServiceClientBuilder.

Parameter
Name Description
cancellationToken CancellationToken

The CancellationToken to use while creating the client.

Returns
Type Description
TaskEnterpriseKnowledgeGraphServiceClient

The task representing the created EnterpriseKnowledgeGraphServiceClient.

CreateEntityReconciliationJob(LocationName, EntityReconciliationJob, CallSettings)

public virtual EntityReconciliationJob CreateEntityReconciliationJob(LocationName parent, EntityReconciliationJob entityReconciliationJob, CallSettings callSettings = null)

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

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.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
EntityReconciliationJob

The RPC response.

Example
// Create client
EnterpriseKnowledgeGraphServiceClient enterpriseKnowledgeGraphServiceClient = EnterpriseKnowledgeGraphServiceClient.Create();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
EntityReconciliationJob entityReconciliationJob = new EntityReconciliationJob();
// Make the request
EntityReconciliationJob response = enterpriseKnowledgeGraphServiceClient.CreateEntityReconciliationJob(parent, entityReconciliationJob);

CreateEntityReconciliationJob(CreateEntityReconciliationJobRequest, CallSettings)

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

Example
// Create client
EnterpriseKnowledgeGraphServiceClient enterpriseKnowledgeGraphServiceClient = EnterpriseKnowledgeGraphServiceClient.Create();
// Initialize request argument(s)
CreateEntityReconciliationJobRequest request = new CreateEntityReconciliationJobRequest
{
    ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
    EntityReconciliationJob = new EntityReconciliationJob(),
};
// Make the request
EntityReconciliationJob response = enterpriseKnowledgeGraphServiceClient.CreateEntityReconciliationJob(request);

CreateEntityReconciliationJob(string, EntityReconciliationJob, CallSettings)

public virtual EntityReconciliationJob CreateEntityReconciliationJob(string parent, EntityReconciliationJob entityReconciliationJob, CallSettings callSettings = null)

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

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.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
EntityReconciliationJob

The RPC response.

Example
// Create client
EnterpriseKnowledgeGraphServiceClient enterpriseKnowledgeGraphServiceClient = EnterpriseKnowledgeGraphServiceClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
EntityReconciliationJob entityReconciliationJob = new EntityReconciliationJob();
// Make the request
EntityReconciliationJob response = enterpriseKnowledgeGraphServiceClient.CreateEntityReconciliationJob(parent, entityReconciliationJob);

CreateEntityReconciliationJobAsync(LocationName, EntityReconciliationJob, CallSettings)

public virtual Task<EntityReconciliationJob> CreateEntityReconciliationJobAsync(LocationName parent, EntityReconciliationJob entityReconciliationJob, CallSettings callSettings = null)

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

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.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskEntityReconciliationJob

A Task containing the RPC response.

Example
// Create client
EnterpriseKnowledgeGraphServiceClient enterpriseKnowledgeGraphServiceClient = await EnterpriseKnowledgeGraphServiceClient.CreateAsync();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
EntityReconciliationJob entityReconciliationJob = new EntityReconciliationJob();
// Make the request
EntityReconciliationJob response = await enterpriseKnowledgeGraphServiceClient.CreateEntityReconciliationJobAsync(parent, entityReconciliationJob);

CreateEntityReconciliationJobAsync(LocationName, EntityReconciliationJob, CancellationToken)

public virtual Task<EntityReconciliationJob> CreateEntityReconciliationJobAsync(LocationName parent, EntityReconciliationJob entityReconciliationJob, CancellationToken cancellationToken)

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

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.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskEntityReconciliationJob

A Task containing the RPC response.

Example
// Create client
EnterpriseKnowledgeGraphServiceClient enterpriseKnowledgeGraphServiceClient = await EnterpriseKnowledgeGraphServiceClient.CreateAsync();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
EntityReconciliationJob entityReconciliationJob = new EntityReconciliationJob();
// Make the request
EntityReconciliationJob response = await enterpriseKnowledgeGraphServiceClient.CreateEntityReconciliationJobAsync(parent, entityReconciliationJob);

CreateEntityReconciliationJobAsync(CreateEntityReconciliationJobRequest, CallSettings)

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

Example
// Create client
EnterpriseKnowledgeGraphServiceClient enterpriseKnowledgeGraphServiceClient = await EnterpriseKnowledgeGraphServiceClient.CreateAsync();
// Initialize request argument(s)
CreateEntityReconciliationJobRequest request = new CreateEntityReconciliationJobRequest
{
    ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
    EntityReconciliationJob = new EntityReconciliationJob(),
};
// Make the request
EntityReconciliationJob response = await enterpriseKnowledgeGraphServiceClient.CreateEntityReconciliationJobAsync(request);

CreateEntityReconciliationJobAsync(CreateEntityReconciliationJobRequest, CancellationToken)

public virtual Task<EntityReconciliationJob> CreateEntityReconciliationJobAsync(CreateEntityReconciliationJobRequest request, CancellationToken cancellationToken)

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.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskEntityReconciliationJob

A Task containing the RPC response.

Example
// Create client
EnterpriseKnowledgeGraphServiceClient enterpriseKnowledgeGraphServiceClient = await EnterpriseKnowledgeGraphServiceClient.CreateAsync();
// Initialize request argument(s)
CreateEntityReconciliationJobRequest request = new CreateEntityReconciliationJobRequest
{
    ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
    EntityReconciliationJob = new EntityReconciliationJob(),
};
// Make the request
EntityReconciliationJob response = await enterpriseKnowledgeGraphServiceClient.CreateEntityReconciliationJobAsync(request);

CreateEntityReconciliationJobAsync(string, EntityReconciliationJob, CallSettings)

public virtual Task<EntityReconciliationJob> CreateEntityReconciliationJobAsync(string parent, EntityReconciliationJob entityReconciliationJob, CallSettings callSettings = null)

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

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.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskEntityReconciliationJob

A Task containing the RPC response.

Example
// Create client
EnterpriseKnowledgeGraphServiceClient enterpriseKnowledgeGraphServiceClient = await EnterpriseKnowledgeGraphServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
EntityReconciliationJob entityReconciliationJob = new EntityReconciliationJob();
// Make the request
EntityReconciliationJob response = await enterpriseKnowledgeGraphServiceClient.CreateEntityReconciliationJobAsync(parent, entityReconciliationJob);

CreateEntityReconciliationJobAsync(string, EntityReconciliationJob, CancellationToken)

public virtual Task<EntityReconciliationJob> CreateEntityReconciliationJobAsync(string parent, EntityReconciliationJob entityReconciliationJob, CancellationToken cancellationToken)

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

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.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskEntityReconciliationJob

A Task containing the RPC response.

Example
// Create client
EnterpriseKnowledgeGraphServiceClient enterpriseKnowledgeGraphServiceClient = await EnterpriseKnowledgeGraphServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
EntityReconciliationJob entityReconciliationJob = new EntityReconciliationJob();
// Make the request
EntityReconciliationJob response = await enterpriseKnowledgeGraphServiceClient.CreateEntityReconciliationJobAsync(parent, entityReconciliationJob);

DeleteEntityReconciliationJob(DeleteEntityReconciliationJobRequest, CallSettings)

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

Example
// Create client
EnterpriseKnowledgeGraphServiceClient enterpriseKnowledgeGraphServiceClient = EnterpriseKnowledgeGraphServiceClient.Create();
// Initialize request argument(s)
DeleteEntityReconciliationJobRequest request = new DeleteEntityReconciliationJobRequest
{
    EntityReconciliationJobName = EntityReconciliationJobName.FromProjectLocationEntityReconciliationJob("[PROJECT]", "[LOCATION]", "[ENTITY_RECONCILIATION_JOB]"),
};
// Make the request
enterpriseKnowledgeGraphServiceClient.DeleteEntityReconciliationJob(request);

DeleteEntityReconciliationJob(EntityReconciliationJobName, CallSettings)

public virtual void DeleteEntityReconciliationJob(EntityReconciliationJobName name, CallSettings callSettings = null)

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

Parameters
Name Description
name EntityReconciliationJobName

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Example
// Create client
EnterpriseKnowledgeGraphServiceClient enterpriseKnowledgeGraphServiceClient = EnterpriseKnowledgeGraphServiceClient.Create();
// Initialize request argument(s)
EntityReconciliationJobName name = EntityReconciliationJobName.FromProjectLocationEntityReconciliationJob("[PROJECT]", "[LOCATION]", "[ENTITY_RECONCILIATION_JOB]");
// Make the request
enterpriseKnowledgeGraphServiceClient.DeleteEntityReconciliationJob(name);

DeleteEntityReconciliationJob(string, CallSettings)

public virtual void DeleteEntityReconciliationJob(string name, CallSettings callSettings = null)

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

Parameters
Name Description
name string

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Example
// Create client
EnterpriseKnowledgeGraphServiceClient enterpriseKnowledgeGraphServiceClient = EnterpriseKnowledgeGraphServiceClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/entityReconciliationJobs/[ENTITY_RECONCILIATION_JOB]";
// Make the request
enterpriseKnowledgeGraphServiceClient.DeleteEntityReconciliationJob(name);

DeleteEntityReconciliationJobAsync(DeleteEntityReconciliationJobRequest, CallSettings)

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

Example
// Create client
EnterpriseKnowledgeGraphServiceClient enterpriseKnowledgeGraphServiceClient = await EnterpriseKnowledgeGraphServiceClient.CreateAsync();
// Initialize request argument(s)
DeleteEntityReconciliationJobRequest request = new DeleteEntityReconciliationJobRequest
{
    EntityReconciliationJobName = EntityReconciliationJobName.FromProjectLocationEntityReconciliationJob("[PROJECT]", "[LOCATION]", "[ENTITY_RECONCILIATION_JOB]"),
};
// Make the request
await enterpriseKnowledgeGraphServiceClient.DeleteEntityReconciliationJobAsync(request);

DeleteEntityReconciliationJobAsync(DeleteEntityReconciliationJobRequest, CancellationToken)

public virtual Task DeleteEntityReconciliationJobAsync(DeleteEntityReconciliationJobRequest request, CancellationToken cancellationToken)

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.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
Task

A Task containing the RPC response.

Example
// Create client
EnterpriseKnowledgeGraphServiceClient enterpriseKnowledgeGraphServiceClient = await EnterpriseKnowledgeGraphServiceClient.CreateAsync();
// Initialize request argument(s)
DeleteEntityReconciliationJobRequest request = new DeleteEntityReconciliationJobRequest
{
    EntityReconciliationJobName = EntityReconciliationJobName.FromProjectLocationEntityReconciliationJob("[PROJECT]", "[LOCATION]", "[ENTITY_RECONCILIATION_JOB]"),
};
// Make the request
await enterpriseKnowledgeGraphServiceClient.DeleteEntityReconciliationJobAsync(request);

DeleteEntityReconciliationJobAsync(EntityReconciliationJobName, CallSettings)

public virtual Task DeleteEntityReconciliationJobAsync(EntityReconciliationJobName name, CallSettings callSettings = null)

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

Parameters
Name Description
name EntityReconciliationJobName

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Task

A Task containing the RPC response.

Example
// Create client
EnterpriseKnowledgeGraphServiceClient enterpriseKnowledgeGraphServiceClient = await EnterpriseKnowledgeGraphServiceClient.CreateAsync();
// Initialize request argument(s)
EntityReconciliationJobName name = EntityReconciliationJobName.FromProjectLocationEntityReconciliationJob("[PROJECT]", "[LOCATION]", "[ENTITY_RECONCILIATION_JOB]");
// Make the request
await enterpriseKnowledgeGraphServiceClient.DeleteEntityReconciliationJobAsync(name);

DeleteEntityReconciliationJobAsync(EntityReconciliationJobName, CancellationToken)

public virtual Task DeleteEntityReconciliationJobAsync(EntityReconciliationJobName name, CancellationToken cancellationToken)

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

Parameters
Name Description
name EntityReconciliationJobName

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

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
Task

A Task containing the RPC response.

Example
// Create client
EnterpriseKnowledgeGraphServiceClient enterpriseKnowledgeGraphServiceClient = await EnterpriseKnowledgeGraphServiceClient.CreateAsync();
// Initialize request argument(s)
EntityReconciliationJobName name = EntityReconciliationJobName.FromProjectLocationEntityReconciliationJob("[PROJECT]", "[LOCATION]", "[ENTITY_RECONCILIATION_JOB]");
// Make the request
await enterpriseKnowledgeGraphServiceClient.DeleteEntityReconciliationJobAsync(name);

DeleteEntityReconciliationJobAsync(string, CallSettings)

public virtual Task DeleteEntityReconciliationJobAsync(string name, CallSettings callSettings = null)

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

Parameters
Name Description
name string

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Task

A Task containing the RPC response.

Example
// Create client
EnterpriseKnowledgeGraphServiceClient enterpriseKnowledgeGraphServiceClient = await EnterpriseKnowledgeGraphServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/entityReconciliationJobs/[ENTITY_RECONCILIATION_JOB]";
// Make the request
await enterpriseKnowledgeGraphServiceClient.DeleteEntityReconciliationJobAsync(name);

DeleteEntityReconciliationJobAsync(string, CancellationToken)

public virtual Task DeleteEntityReconciliationJobAsync(string name, CancellationToken cancellationToken)

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

Parameters
Name Description
name string

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

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
Task

A Task containing the RPC response.

Example
// Create client
EnterpriseKnowledgeGraphServiceClient enterpriseKnowledgeGraphServiceClient = await EnterpriseKnowledgeGraphServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/entityReconciliationJobs/[ENTITY_RECONCILIATION_JOB]";
// Make the request
await enterpriseKnowledgeGraphServiceClient.DeleteEntityReconciliationJobAsync(name);

GetEntityReconciliationJob(EntityReconciliationJobName, CallSettings)

public virtual EntityReconciliationJob GetEntityReconciliationJob(EntityReconciliationJobName name, CallSettings callSettings = null)

Gets a EntityReconciliationJob.

Parameters
Name Description
name EntityReconciliationJobName

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
EntityReconciliationJob

The RPC response.

Example
// Create client
EnterpriseKnowledgeGraphServiceClient enterpriseKnowledgeGraphServiceClient = EnterpriseKnowledgeGraphServiceClient.Create();
// Initialize request argument(s)
EntityReconciliationJobName name = EntityReconciliationJobName.FromProjectLocationEntityReconciliationJob("[PROJECT]", "[LOCATION]", "[ENTITY_RECONCILIATION_JOB]");
// Make the request
EntityReconciliationJob response = enterpriseKnowledgeGraphServiceClient.GetEntityReconciliationJob(name);

GetEntityReconciliationJob(GetEntityReconciliationJobRequest, CallSettings)

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

Example
// Create client
EnterpriseKnowledgeGraphServiceClient enterpriseKnowledgeGraphServiceClient = EnterpriseKnowledgeGraphServiceClient.Create();
// Initialize request argument(s)
GetEntityReconciliationJobRequest request = new GetEntityReconciliationJobRequest
{
    EntityReconciliationJobName = EntityReconciliationJobName.FromProjectLocationEntityReconciliationJob("[PROJECT]", "[LOCATION]", "[ENTITY_RECONCILIATION_JOB]"),
};
// Make the request
EntityReconciliationJob response = enterpriseKnowledgeGraphServiceClient.GetEntityReconciliationJob(request);

GetEntityReconciliationJob(string, CallSettings)

public virtual EntityReconciliationJob GetEntityReconciliationJob(string name, CallSettings callSettings = null)

Gets a EntityReconciliationJob.

Parameters
Name Description
name string

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
EntityReconciliationJob

The RPC response.

Example
// Create client
EnterpriseKnowledgeGraphServiceClient enterpriseKnowledgeGraphServiceClient = EnterpriseKnowledgeGraphServiceClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/entityReconciliationJobs/[ENTITY_RECONCILIATION_JOB]";
// Make the request
EntityReconciliationJob response = enterpriseKnowledgeGraphServiceClient.GetEntityReconciliationJob(name);

GetEntityReconciliationJobAsync(EntityReconciliationJobName, CallSettings)

public virtual Task<EntityReconciliationJob> GetEntityReconciliationJobAsync(EntityReconciliationJobName name, CallSettings callSettings = null)

Gets a EntityReconciliationJob.

Parameters
Name Description
name EntityReconciliationJobName

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskEntityReconciliationJob

A Task containing the RPC response.

Example
// Create client
EnterpriseKnowledgeGraphServiceClient enterpriseKnowledgeGraphServiceClient = await EnterpriseKnowledgeGraphServiceClient.CreateAsync();
// Initialize request argument(s)
EntityReconciliationJobName name = EntityReconciliationJobName.FromProjectLocationEntityReconciliationJob("[PROJECT]", "[LOCATION]", "[ENTITY_RECONCILIATION_JOB]");
// Make the request
EntityReconciliationJob response = await enterpriseKnowledgeGraphServiceClient.GetEntityReconciliationJobAsync(name);

GetEntityReconciliationJobAsync(EntityReconciliationJobName, CancellationToken)

public virtual Task<EntityReconciliationJob> GetEntityReconciliationJobAsync(EntityReconciliationJobName name, CancellationToken cancellationToken)

Gets a EntityReconciliationJob.

Parameters
Name Description
name EntityReconciliationJobName

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

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskEntityReconciliationJob

A Task containing the RPC response.

Example
// Create client
EnterpriseKnowledgeGraphServiceClient enterpriseKnowledgeGraphServiceClient = await EnterpriseKnowledgeGraphServiceClient.CreateAsync();
// Initialize request argument(s)
EntityReconciliationJobName name = EntityReconciliationJobName.FromProjectLocationEntityReconciliationJob("[PROJECT]", "[LOCATION]", "[ENTITY_RECONCILIATION_JOB]");
// Make the request
EntityReconciliationJob response = await enterpriseKnowledgeGraphServiceClient.GetEntityReconciliationJobAsync(name);

GetEntityReconciliationJobAsync(GetEntityReconciliationJobRequest, CallSettings)

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

Example
// Create client
EnterpriseKnowledgeGraphServiceClient enterpriseKnowledgeGraphServiceClient = await EnterpriseKnowledgeGraphServiceClient.CreateAsync();
// Initialize request argument(s)
GetEntityReconciliationJobRequest request = new GetEntityReconciliationJobRequest
{
    EntityReconciliationJobName = EntityReconciliationJobName.FromProjectLocationEntityReconciliationJob("[PROJECT]", "[LOCATION]", "[ENTITY_RECONCILIATION_JOB]"),
};
// Make the request
EntityReconciliationJob response = await enterpriseKnowledgeGraphServiceClient.GetEntityReconciliationJobAsync(request);

GetEntityReconciliationJobAsync(GetEntityReconciliationJobRequest, CancellationToken)

public virtual Task<EntityReconciliationJob> GetEntityReconciliationJobAsync(GetEntityReconciliationJobRequest request, CancellationToken cancellationToken)

Gets a EntityReconciliationJob.

Parameters
Name Description
request GetEntityReconciliationJobRequest

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

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskEntityReconciliationJob

A Task containing the RPC response.

Example
// Create client
EnterpriseKnowledgeGraphServiceClient enterpriseKnowledgeGraphServiceClient = await EnterpriseKnowledgeGraphServiceClient.CreateAsync();
// Initialize request argument(s)
GetEntityReconciliationJobRequest request = new GetEntityReconciliationJobRequest
{
    EntityReconciliationJobName = EntityReconciliationJobName.FromProjectLocationEntityReconciliationJob("[PROJECT]", "[LOCATION]", "[ENTITY_RECONCILIATION_JOB]"),
};
// Make the request
EntityReconciliationJob response = await enterpriseKnowledgeGraphServiceClient.GetEntityReconciliationJobAsync(request);

GetEntityReconciliationJobAsync(string, CallSettings)

public virtual Task<EntityReconciliationJob> GetEntityReconciliationJobAsync(string name, CallSettings callSettings = null)

Gets a EntityReconciliationJob.

Parameters
Name Description
name string

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskEntityReconciliationJob

A Task containing the RPC response.

Example
// Create client
EnterpriseKnowledgeGraphServiceClient enterpriseKnowledgeGraphServiceClient = await EnterpriseKnowledgeGraphServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/entityReconciliationJobs/[ENTITY_RECONCILIATION_JOB]";
// Make the request
EntityReconciliationJob response = await enterpriseKnowledgeGraphServiceClient.GetEntityReconciliationJobAsync(name);

GetEntityReconciliationJobAsync(string, CancellationToken)

public virtual Task<EntityReconciliationJob> GetEntityReconciliationJobAsync(string name, CancellationToken cancellationToken)

Gets a EntityReconciliationJob.

Parameters
Name Description
name string

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

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskEntityReconciliationJob

A Task containing the RPC response.

Example
// Create client
EnterpriseKnowledgeGraphServiceClient enterpriseKnowledgeGraphServiceClient = await EnterpriseKnowledgeGraphServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/entityReconciliationJobs/[ENTITY_RECONCILIATION_JOB]";
// Make the request
EntityReconciliationJob response = await enterpriseKnowledgeGraphServiceClient.GetEntityReconciliationJobAsync(name);

ListEntityReconciliationJobs(LocationName, string, int?, CallSettings)

public virtual PagedEnumerable<ListEntityReconciliationJobsResponse, EntityReconciliationJob> ListEntityReconciliationJobs(LocationName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists Entity Reconciliation Jobs.

Parameters
Name Description
parent LocationName

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

pageToken string

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSize int

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedEnumerableListEntityReconciliationJobsResponseEntityReconciliationJob

A pageable sequence of EntityReconciliationJob resources.

Example
// Create client
EnterpriseKnowledgeGraphServiceClient enterpriseKnowledgeGraphServiceClient = EnterpriseKnowledgeGraphServiceClient.Create();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
// Make the request
PagedEnumerable<ListEntityReconciliationJobsResponse, EntityReconciliationJob> response = enterpriseKnowledgeGraphServiceClient.ListEntityReconciliationJobs(parent);

// Iterate over all response items, lazily performing RPCs as required
foreach (EntityReconciliationJob item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListEntityReconciliationJobsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (EntityReconciliationJob item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<EntityReconciliationJob> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (EntityReconciliationJob item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListEntityReconciliationJobs(ListEntityReconciliationJobsRequest, CallSettings)

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

Example
// Create client
EnterpriseKnowledgeGraphServiceClient enterpriseKnowledgeGraphServiceClient = EnterpriseKnowledgeGraphServiceClient.Create();
// Initialize request argument(s)
ListEntityReconciliationJobsRequest request = new ListEntityReconciliationJobsRequest
{
    ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
    Filter = "",
};
// Make the request
PagedEnumerable<ListEntityReconciliationJobsResponse, EntityReconciliationJob> response = enterpriseKnowledgeGraphServiceClient.ListEntityReconciliationJobs(request);

// Iterate over all response items, lazily performing RPCs as required
foreach (EntityReconciliationJob item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListEntityReconciliationJobsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (EntityReconciliationJob item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<EntityReconciliationJob> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (EntityReconciliationJob item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListEntityReconciliationJobs(string, string, int?, CallSettings)

public virtual PagedEnumerable<ListEntityReconciliationJobsResponse, EntityReconciliationJob> ListEntityReconciliationJobs(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists Entity Reconciliation Jobs.

Parameters
Name Description
parent string

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

pageToken string

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSize int

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedEnumerableListEntityReconciliationJobsResponseEntityReconciliationJob

A pageable sequence of EntityReconciliationJob resources.

Example
// Create client
EnterpriseKnowledgeGraphServiceClient enterpriseKnowledgeGraphServiceClient = EnterpriseKnowledgeGraphServiceClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
// Make the request
PagedEnumerable<ListEntityReconciliationJobsResponse, EntityReconciliationJob> response = enterpriseKnowledgeGraphServiceClient.ListEntityReconciliationJobs(parent);

// Iterate over all response items, lazily performing RPCs as required
foreach (EntityReconciliationJob item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListEntityReconciliationJobsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (EntityReconciliationJob item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<EntityReconciliationJob> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (EntityReconciliationJob item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListEntityReconciliationJobsAsync(LocationName, string, int?, CallSettings)

public virtual PagedAsyncEnumerable<ListEntityReconciliationJobsResponse, EntityReconciliationJob> ListEntityReconciliationJobsAsync(LocationName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists Entity Reconciliation Jobs.

Parameters
Name Description
parent LocationName

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

pageToken string

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSize int

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedAsyncEnumerableListEntityReconciliationJobsResponseEntityReconciliationJob

A pageable asynchronous sequence of EntityReconciliationJob resources.

Example
// Create client
EnterpriseKnowledgeGraphServiceClient enterpriseKnowledgeGraphServiceClient = await EnterpriseKnowledgeGraphServiceClient.CreateAsync();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
// Make the request
PagedAsyncEnumerable<ListEntityReconciliationJobsResponse, EntityReconciliationJob> response = enterpriseKnowledgeGraphServiceClient.ListEntityReconciliationJobsAsync(parent);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((EntityReconciliationJob item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListEntityReconciliationJobsResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (EntityReconciliationJob item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<EntityReconciliationJob> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (EntityReconciliationJob item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListEntityReconciliationJobsAsync(ListEntityReconciliationJobsRequest, CallSettings)

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

Example
// Create client
EnterpriseKnowledgeGraphServiceClient enterpriseKnowledgeGraphServiceClient = await EnterpriseKnowledgeGraphServiceClient.CreateAsync();
// Initialize request argument(s)
ListEntityReconciliationJobsRequest request = new ListEntityReconciliationJobsRequest
{
    ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
    Filter = "",
};
// Make the request
PagedAsyncEnumerable<ListEntityReconciliationJobsResponse, EntityReconciliationJob> response = enterpriseKnowledgeGraphServiceClient.ListEntityReconciliationJobsAsync(request);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((EntityReconciliationJob item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListEntityReconciliationJobsResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (EntityReconciliationJob item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<EntityReconciliationJob> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (EntityReconciliationJob item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListEntityReconciliationJobsAsync(string, string, int?, CallSettings)

public virtual PagedAsyncEnumerable<ListEntityReconciliationJobsResponse, EntityReconciliationJob> ListEntityReconciliationJobsAsync(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists Entity Reconciliation Jobs.

Parameters
Name Description
parent string

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

pageToken string

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSize int

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedAsyncEnumerableListEntityReconciliationJobsResponseEntityReconciliationJob

A pageable asynchronous sequence of EntityReconciliationJob resources.

Example
// Create client
EnterpriseKnowledgeGraphServiceClient enterpriseKnowledgeGraphServiceClient = await EnterpriseKnowledgeGraphServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
// Make the request
PagedAsyncEnumerable<ListEntityReconciliationJobsResponse, EntityReconciliationJob> response = enterpriseKnowledgeGraphServiceClient.ListEntityReconciliationJobsAsync(parent);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((EntityReconciliationJob item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListEntityReconciliationJobsResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (EntityReconciliationJob item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<EntityReconciliationJob> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (EntityReconciliationJob item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

Lookup(LocationName, IEnumerable<string>, CallSettings)

public virtual LookupResponse Lookup(LocationName parent, IEnumerable<string> ids, CallSettings callSettings = null)

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

Parameters
Name Description
parent LocationName

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

ids IEnumerablestring

Required. The list of entity ids to be used for lookup.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
LookupResponse

The RPC response.

Example
// Create client
EnterpriseKnowledgeGraphServiceClient enterpriseKnowledgeGraphServiceClient = EnterpriseKnowledgeGraphServiceClient.Create();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
IEnumerable<string> ids = new string[] { "", };
// Make the request
LookupResponse response = enterpriseKnowledgeGraphServiceClient.Lookup(parent, ids);

Lookup(LookupRequest, CallSettings)

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

Example
// Create client
EnterpriseKnowledgeGraphServiceClient enterpriseKnowledgeGraphServiceClient = EnterpriseKnowledgeGraphServiceClient.Create();
// Initialize request argument(s)
LookupRequest request = new LookupRequest
{
    ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
    Ids = { "", },
    Languages = { "", },
};
// Make the request
LookupResponse response = enterpriseKnowledgeGraphServiceClient.Lookup(request);

Lookup(string, IEnumerable<string>, CallSettings)

public virtual LookupResponse Lookup(string parent, IEnumerable<string> ids, CallSettings callSettings = null)

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

Parameters
Name Description
parent string

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

ids IEnumerablestring

Required. The list of entity ids to be used for lookup.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
LookupResponse

The RPC response.

Example
// Create client
EnterpriseKnowledgeGraphServiceClient enterpriseKnowledgeGraphServiceClient = EnterpriseKnowledgeGraphServiceClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
IEnumerable<string> ids = new string[] { "", };
// Make the request
LookupResponse response = enterpriseKnowledgeGraphServiceClient.Lookup(parent, ids);

LookupAsync(LocationName, IEnumerable<string>, CallSettings)

public virtual Task<LookupResponse> LookupAsync(LocationName parent, IEnumerable<string> ids, CallSettings callSettings = null)

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

Parameters
Name Description
parent LocationName

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

ids IEnumerablestring

Required. The list of entity ids to be used for lookup.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskLookupResponse

A Task containing the RPC response.

Example
// Create client
EnterpriseKnowledgeGraphServiceClient enterpriseKnowledgeGraphServiceClient = await EnterpriseKnowledgeGraphServiceClient.CreateAsync();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
IEnumerable<string> ids = new string[] { "", };
// Make the request
LookupResponse response = await enterpriseKnowledgeGraphServiceClient.LookupAsync(parent, ids);

LookupAsync(LocationName, IEnumerable<string>, CancellationToken)

public virtual Task<LookupResponse> LookupAsync(LocationName parent, IEnumerable<string> ids, CancellationToken cancellationToken)

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

Parameters
Name Description
parent LocationName

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

ids IEnumerablestring

Required. The list of entity ids to be used for lookup.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskLookupResponse

A Task containing the RPC response.

Example
// Create client
EnterpriseKnowledgeGraphServiceClient enterpriseKnowledgeGraphServiceClient = await EnterpriseKnowledgeGraphServiceClient.CreateAsync();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
IEnumerable<string> ids = new string[] { "", };
// Make the request
LookupResponse response = await enterpriseKnowledgeGraphServiceClient.LookupAsync(parent, ids);

LookupAsync(LookupRequest, CallSettings)

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

Example
// Create client
EnterpriseKnowledgeGraphServiceClient enterpriseKnowledgeGraphServiceClient = await EnterpriseKnowledgeGraphServiceClient.CreateAsync();
// Initialize request argument(s)
LookupRequest request = new LookupRequest
{
    ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
    Ids = { "", },
    Languages = { "", },
};
// Make the request
LookupResponse response = await enterpriseKnowledgeGraphServiceClient.LookupAsync(request);

LookupAsync(LookupRequest, CancellationToken)

public virtual Task<LookupResponse> LookupAsync(LookupRequest request, CancellationToken cancellationToken)

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.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskLookupResponse

A Task containing the RPC response.

Example
// Create client
EnterpriseKnowledgeGraphServiceClient enterpriseKnowledgeGraphServiceClient = await EnterpriseKnowledgeGraphServiceClient.CreateAsync();
// Initialize request argument(s)
LookupRequest request = new LookupRequest
{
    ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
    Ids = { "", },
    Languages = { "", },
};
// Make the request
LookupResponse response = await enterpriseKnowledgeGraphServiceClient.LookupAsync(request);

LookupAsync(string, IEnumerable<string>, CallSettings)

public virtual Task<LookupResponse> LookupAsync(string parent, IEnumerable<string> ids, CallSettings callSettings = null)

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

Parameters
Name Description
parent string

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

ids IEnumerablestring

Required. The list of entity ids to be used for lookup.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskLookupResponse

A Task containing the RPC response.

Example
// Create client
EnterpriseKnowledgeGraphServiceClient enterpriseKnowledgeGraphServiceClient = await EnterpriseKnowledgeGraphServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
IEnumerable<string> ids = new string[] { "", };
// Make the request
LookupResponse response = await enterpriseKnowledgeGraphServiceClient.LookupAsync(parent, ids);

LookupAsync(string, IEnumerable<string>, CancellationToken)

public virtual Task<LookupResponse> LookupAsync(string parent, IEnumerable<string> ids, CancellationToken cancellationToken)

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

Parameters
Name Description
parent string

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

ids IEnumerablestring

Required. The list of entity ids to be used for lookup.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskLookupResponse

A Task containing the RPC response.

Example
// Create client
EnterpriseKnowledgeGraphServiceClient enterpriseKnowledgeGraphServiceClient = await EnterpriseKnowledgeGraphServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
IEnumerable<string> ids = new string[] { "", };
// Make the request
LookupResponse response = await enterpriseKnowledgeGraphServiceClient.LookupAsync(parent, ids);

LookupPublicKg(LocationName, IEnumerable<string>, CallSettings)

public virtual LookupPublicKgResponse LookupPublicKg(LocationName parent, IEnumerable<string> ids, CallSettings callSettings = null)

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

Parameters
Name Description
parent LocationName

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

ids IEnumerablestring

Required. The list of entity ids to be used for lookup.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
LookupPublicKgResponse

The RPC response.

Example
// Create client
EnterpriseKnowledgeGraphServiceClient enterpriseKnowledgeGraphServiceClient = EnterpriseKnowledgeGraphServiceClient.Create();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
IEnumerable<string> ids = new string[] { "", };
// Make the request
LookupPublicKgResponse response = enterpriseKnowledgeGraphServiceClient.LookupPublicKg(parent, ids);

LookupPublicKg(LookupPublicKgRequest, CallSettings)

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

Example
// Create client
EnterpriseKnowledgeGraphServiceClient enterpriseKnowledgeGraphServiceClient = EnterpriseKnowledgeGraphServiceClient.Create();
// Initialize request argument(s)
LookupPublicKgRequest request = new LookupPublicKgRequest
{
    ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
    Ids = { "", },
    Languages = { "", },
};
// Make the request
LookupPublicKgResponse response = enterpriseKnowledgeGraphServiceClient.LookupPublicKg(request);

LookupPublicKg(string, IEnumerable<string>, CallSettings)

public virtual LookupPublicKgResponse LookupPublicKg(string parent, IEnumerable<string> ids, CallSettings callSettings = null)

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

Parameters
Name Description
parent string

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

ids IEnumerablestring

Required. The list of entity ids to be used for lookup.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
LookupPublicKgResponse

The RPC response.

Example
// Create client
EnterpriseKnowledgeGraphServiceClient enterpriseKnowledgeGraphServiceClient = EnterpriseKnowledgeGraphServiceClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
IEnumerable<string> ids = new string[] { "", };
// Make the request
LookupPublicKgResponse response = enterpriseKnowledgeGraphServiceClient.LookupPublicKg(parent, ids);

LookupPublicKgAsync(LocationName, IEnumerable<string>, CallSettings)

public virtual Task<LookupPublicKgResponse> LookupPublicKgAsync(LocationName parent, IEnumerable<string> ids, CallSettings callSettings = null)

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

Parameters
Name Description
parent LocationName

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

ids IEnumerablestring

Required. The list of entity ids to be used for lookup.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskLookupPublicKgResponse

A Task containing the RPC response.

Example
// Create client
EnterpriseKnowledgeGraphServiceClient enterpriseKnowledgeGraphServiceClient = await EnterpriseKnowledgeGraphServiceClient.CreateAsync();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
IEnumerable<string> ids = new string[] { "", };
// Make the request
LookupPublicKgResponse response = await enterpriseKnowledgeGraphServiceClient.LookupPublicKgAsync(parent, ids);

LookupPublicKgAsync(LocationName, IEnumerable<string>, CancellationToken)

public virtual Task<LookupPublicKgResponse> LookupPublicKgAsync(LocationName parent, IEnumerable<string> ids, CancellationToken cancellationToken)

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

Parameters
Name Description
parent LocationName

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

ids IEnumerablestring

Required. The list of entity ids to be used for lookup.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskLookupPublicKgResponse

A Task containing the RPC response.

Example
// Create client
EnterpriseKnowledgeGraphServiceClient enterpriseKnowledgeGraphServiceClient = await EnterpriseKnowledgeGraphServiceClient.CreateAsync();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
IEnumerable<string> ids = new string[] { "", };
// Make the request
LookupPublicKgResponse response = await enterpriseKnowledgeGraphServiceClient.LookupPublicKgAsync(parent, ids);

LookupPublicKgAsync(LookupPublicKgRequest, CallSettings)

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

Example
// Create client
EnterpriseKnowledgeGraphServiceClient enterpriseKnowledgeGraphServiceClient = await EnterpriseKnowledgeGraphServiceClient.CreateAsync();
// Initialize request argument(s)
LookupPublicKgRequest request = new LookupPublicKgRequest
{
    ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
    Ids = { "", },
    Languages = { "", },
};
// Make the request
LookupPublicKgResponse response = await enterpriseKnowledgeGraphServiceClient.LookupPublicKgAsync(request);

LookupPublicKgAsync(LookupPublicKgRequest, CancellationToken)

public virtual Task<LookupPublicKgResponse> LookupPublicKgAsync(LookupPublicKgRequest request, CancellationToken cancellationToken)

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.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskLookupPublicKgResponse

A Task containing the RPC response.

Example
// Create client
EnterpriseKnowledgeGraphServiceClient enterpriseKnowledgeGraphServiceClient = await EnterpriseKnowledgeGraphServiceClient.CreateAsync();
// Initialize request argument(s)
LookupPublicKgRequest request = new LookupPublicKgRequest
{
    ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
    Ids = { "", },
    Languages = { "", },
};
// Make the request
LookupPublicKgResponse response = await enterpriseKnowledgeGraphServiceClient.LookupPublicKgAsync(request);

LookupPublicKgAsync(string, IEnumerable<string>, CallSettings)

public virtual Task<LookupPublicKgResponse> LookupPublicKgAsync(string parent, IEnumerable<string> ids, CallSettings callSettings = null)

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

Parameters
Name Description
parent string

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

ids IEnumerablestring

Required. The list of entity ids to be used for lookup.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskLookupPublicKgResponse

A Task containing the RPC response.

Example
// Create client
EnterpriseKnowledgeGraphServiceClient enterpriseKnowledgeGraphServiceClient = await EnterpriseKnowledgeGraphServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
IEnumerable<string> ids = new string[] { "", };
// Make the request
LookupPublicKgResponse response = await enterpriseKnowledgeGraphServiceClient.LookupPublicKgAsync(parent, ids);

LookupPublicKgAsync(string, IEnumerable<string>, CancellationToken)

public virtual Task<LookupPublicKgResponse> LookupPublicKgAsync(string parent, IEnumerable<string> ids, CancellationToken cancellationToken)

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

Parameters
Name Description
parent string

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

ids IEnumerablestring

Required. The list of entity ids to be used for lookup.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskLookupPublicKgResponse

A Task containing the RPC response.

Example
// Create client
EnterpriseKnowledgeGraphServiceClient enterpriseKnowledgeGraphServiceClient = await EnterpriseKnowledgeGraphServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
IEnumerable<string> ids = new string[] { "", };
// Make the request
LookupPublicKgResponse response = await enterpriseKnowledgeGraphServiceClient.LookupPublicKgAsync(parent, ids);

Search(LocationName, string, CallSettings)

public virtual SearchResponse Search(LocationName parent, string query, CallSettings callSettings = null)

Searches the Cloud KG entities with entity name.

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.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
SearchResponse

The RPC response.

Example
// Create client
EnterpriseKnowledgeGraphServiceClient enterpriseKnowledgeGraphServiceClient = EnterpriseKnowledgeGraphServiceClient.Create();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
string query = "";
// Make the request
SearchResponse response = enterpriseKnowledgeGraphServiceClient.Search(parent, query);

Search(SearchRequest, CallSettings)

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

Example
// Create client
EnterpriseKnowledgeGraphServiceClient enterpriseKnowledgeGraphServiceClient = EnterpriseKnowledgeGraphServiceClient.Create();
// Initialize request argument(s)
SearchRequest request = new SearchRequest
{
    ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
    Query = "",
    Languages = { "", },
    Types_ = { "", },
    Limit = 0,
};
// Make the request
SearchResponse response = enterpriseKnowledgeGraphServiceClient.Search(request);

Search(string, string, CallSettings)

public virtual SearchResponse Search(string parent, string query, CallSettings callSettings = null)

Searches the Cloud KG entities with entity name.

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.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
SearchResponse

The RPC response.

Example
// Create client
EnterpriseKnowledgeGraphServiceClient enterpriseKnowledgeGraphServiceClient = EnterpriseKnowledgeGraphServiceClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
string query = "";
// Make the request
SearchResponse response = enterpriseKnowledgeGraphServiceClient.Search(parent, query);

SearchAsync(LocationName, string, CallSettings)

public virtual Task<SearchResponse> SearchAsync(LocationName parent, string query, CallSettings callSettings = null)

Searches the Cloud KG entities with entity name.

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.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskSearchResponse

A Task containing the RPC response.

Example
// Create client
EnterpriseKnowledgeGraphServiceClient enterpriseKnowledgeGraphServiceClient = await EnterpriseKnowledgeGraphServiceClient.CreateAsync();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
string query = "";
// Make the request
SearchResponse response = await enterpriseKnowledgeGraphServiceClient.SearchAsync(parent, query);

SearchAsync(LocationName, string, CancellationToken)

public virtual Task<SearchResponse> SearchAsync(LocationName parent, string query, CancellationToken cancellationToken)

Searches the Cloud KG entities with entity name.

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.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskSearchResponse

A Task containing the RPC response.

Example
// Create client
EnterpriseKnowledgeGraphServiceClient enterpriseKnowledgeGraphServiceClient = await EnterpriseKnowledgeGraphServiceClient.CreateAsync();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
string query = "";
// Make the request
SearchResponse response = await enterpriseKnowledgeGraphServiceClient.SearchAsync(parent, query);

SearchAsync(SearchRequest, CallSettings)

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

Example
// Create client
EnterpriseKnowledgeGraphServiceClient enterpriseKnowledgeGraphServiceClient = await EnterpriseKnowledgeGraphServiceClient.CreateAsync();
// Initialize request argument(s)
SearchRequest request = new SearchRequest
{
    ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
    Query = "",
    Languages = { "", },
    Types_ = { "", },
    Limit = 0,
};
// Make the request
SearchResponse response = await enterpriseKnowledgeGraphServiceClient.SearchAsync(request);

SearchAsync(SearchRequest, CancellationToken)

public virtual Task<SearchResponse> SearchAsync(SearchRequest request, CancellationToken cancellationToken)

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.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskSearchResponse

A Task containing the RPC response.

Example
// Create client
EnterpriseKnowledgeGraphServiceClient enterpriseKnowledgeGraphServiceClient = await EnterpriseKnowledgeGraphServiceClient.CreateAsync();
// Initialize request argument(s)
SearchRequest request = new SearchRequest
{
    ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
    Query = "",
    Languages = { "", },
    Types_ = { "", },
    Limit = 0,
};
// Make the request
SearchResponse response = await enterpriseKnowledgeGraphServiceClient.SearchAsync(request);

SearchAsync(string, string, CallSettings)

public virtual Task<SearchResponse> SearchAsync(string parent, string query, CallSettings callSettings = null)

Searches the Cloud KG entities with entity name.

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.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskSearchResponse

A Task containing the RPC response.

Example
// Create client
EnterpriseKnowledgeGraphServiceClient enterpriseKnowledgeGraphServiceClient = await EnterpriseKnowledgeGraphServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
string query = "";
// Make the request
SearchResponse response = await enterpriseKnowledgeGraphServiceClient.SearchAsync(parent, query);

SearchAsync(string, string, CancellationToken)

public virtual Task<SearchResponse> SearchAsync(string parent, string query, CancellationToken cancellationToken)

Searches the Cloud KG entities with entity name.

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.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskSearchResponse

A Task containing the RPC response.

Example
// Create client
EnterpriseKnowledgeGraphServiceClient enterpriseKnowledgeGraphServiceClient = await EnterpriseKnowledgeGraphServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
string query = "";
// Make the request
SearchResponse response = await enterpriseKnowledgeGraphServiceClient.SearchAsync(parent, query);

SearchPublicKg(LocationName, string, CallSettings)

public virtual SearchPublicKgResponse SearchPublicKg(LocationName parent, string query, CallSettings callSettings = null)

Searches the public KG entities with entity name.

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.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
SearchPublicKgResponse

The RPC response.

Example
// Create client
EnterpriseKnowledgeGraphServiceClient enterpriseKnowledgeGraphServiceClient = EnterpriseKnowledgeGraphServiceClient.Create();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
string query = "";
// Make the request
SearchPublicKgResponse response = enterpriseKnowledgeGraphServiceClient.SearchPublicKg(parent, query);

SearchPublicKg(SearchPublicKgRequest, CallSettings)

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

Example
// Create client
EnterpriseKnowledgeGraphServiceClient enterpriseKnowledgeGraphServiceClient = EnterpriseKnowledgeGraphServiceClient.Create();
// Initialize request argument(s)
SearchPublicKgRequest request = new SearchPublicKgRequest
{
    ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
    Query = "",
    Languages = { "", },
    Types_ = { "", },
    Limit = 0,
};
// Make the request
SearchPublicKgResponse response = enterpriseKnowledgeGraphServiceClient.SearchPublicKg(request);

SearchPublicKg(string, string, CallSettings)

public virtual SearchPublicKgResponse SearchPublicKg(string parent, string query, CallSettings callSettings = null)

Searches the public KG entities with entity name.

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.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
SearchPublicKgResponse

The RPC response.

Example
// Create client
EnterpriseKnowledgeGraphServiceClient enterpriseKnowledgeGraphServiceClient = EnterpriseKnowledgeGraphServiceClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
string query = "";
// Make the request
SearchPublicKgResponse response = enterpriseKnowledgeGraphServiceClient.SearchPublicKg(parent, query);

SearchPublicKgAsync(LocationName, string, CallSettings)

public virtual Task<SearchPublicKgResponse> SearchPublicKgAsync(LocationName parent, string query, CallSettings callSettings = null)

Searches the public KG entities with entity name.

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.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskSearchPublicKgResponse

A Task containing the RPC response.

Example
// Create client
EnterpriseKnowledgeGraphServiceClient enterpriseKnowledgeGraphServiceClient = await EnterpriseKnowledgeGraphServiceClient.CreateAsync();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
string query = "";
// Make the request
SearchPublicKgResponse response = await enterpriseKnowledgeGraphServiceClient.SearchPublicKgAsync(parent, query);

SearchPublicKgAsync(LocationName, string, CancellationToken)

public virtual Task<SearchPublicKgResponse> SearchPublicKgAsync(LocationName parent, string query, CancellationToken cancellationToken)

Searches the public KG entities with entity name.

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.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskSearchPublicKgResponse

A Task containing the RPC response.

Example
// Create client
EnterpriseKnowledgeGraphServiceClient enterpriseKnowledgeGraphServiceClient = await EnterpriseKnowledgeGraphServiceClient.CreateAsync();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
string query = "";
// Make the request
SearchPublicKgResponse response = await enterpriseKnowledgeGraphServiceClient.SearchPublicKgAsync(parent, query);

SearchPublicKgAsync(SearchPublicKgRequest, CallSettings)

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

Example
// Create client
EnterpriseKnowledgeGraphServiceClient enterpriseKnowledgeGraphServiceClient = await EnterpriseKnowledgeGraphServiceClient.CreateAsync();
// Initialize request argument(s)
SearchPublicKgRequest request = new SearchPublicKgRequest
{
    ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
    Query = "",
    Languages = { "", },
    Types_ = { "", },
    Limit = 0,
};
// Make the request
SearchPublicKgResponse response = await enterpriseKnowledgeGraphServiceClient.SearchPublicKgAsync(request);

SearchPublicKgAsync(SearchPublicKgRequest, CancellationToken)

public virtual Task<SearchPublicKgResponse> SearchPublicKgAsync(SearchPublicKgRequest request, CancellationToken cancellationToken)

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.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskSearchPublicKgResponse

A Task containing the RPC response.

Example
// Create client
EnterpriseKnowledgeGraphServiceClient enterpriseKnowledgeGraphServiceClient = await EnterpriseKnowledgeGraphServiceClient.CreateAsync();
// Initialize request argument(s)
SearchPublicKgRequest request = new SearchPublicKgRequest
{
    ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
    Query = "",
    Languages = { "", },
    Types_ = { "", },
    Limit = 0,
};
// Make the request
SearchPublicKgResponse response = await enterpriseKnowledgeGraphServiceClient.SearchPublicKgAsync(request);

SearchPublicKgAsync(string, string, CallSettings)

public virtual Task<SearchPublicKgResponse> SearchPublicKgAsync(string parent, string query, CallSettings callSettings = null)

Searches the public KG entities with entity name.

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.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskSearchPublicKgResponse

A Task containing the RPC response.

Example
// Create client
EnterpriseKnowledgeGraphServiceClient enterpriseKnowledgeGraphServiceClient = await EnterpriseKnowledgeGraphServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
string query = "";
// Make the request
SearchPublicKgResponse response = await enterpriseKnowledgeGraphServiceClient.SearchPublicKgAsync(parent, query);

SearchPublicKgAsync(string, string, CancellationToken)

public virtual Task<SearchPublicKgResponse> SearchPublicKgAsync(string parent, string query, CancellationToken cancellationToken)

Searches the public KG entities with entity name.

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.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskSearchPublicKgResponse

A Task containing the RPC response.

Example
// Create client
EnterpriseKnowledgeGraphServiceClient enterpriseKnowledgeGraphServiceClient = await EnterpriseKnowledgeGraphServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
string query = "";
// Make the request
SearchPublicKgResponse response = await enterpriseKnowledgeGraphServiceClient.SearchPublicKgAsync(parent, query);

ShutdownDefaultChannelsAsync()

public static Task ShutdownDefaultChannelsAsync()

Shuts down any channels automatically created by Create() and CreateAsync(CancellationToken). Channels which weren't automatically created are not affected.

Returns
Type Description
Task

A task representing the asynchronous shutdown operation.

Remarks

After calling this method, further calls to Create() and CreateAsync(CancellationToken) will create new channels, which could in turn be shut down by another call to this method.