Discovery Engine v1 API - Class DataConnectorServiceClient (1.17.0) 

public abstract class DataConnectorServiceClient

Reference documentation and code samples for the Discovery Engine v1 API class DataConnectorServiceClient.

DataConnectorService client wrapper, for convenient use.

Inheritance

object > DataConnectorServiceClient

Namespace

Google.Cloud.DiscoveryEngine.V1

Assembly

Google.Cloud.DiscoveryEngine.V1.dll

Remarks

Service for data connector management.

Properties

DefaultEndpoint

public static string DefaultEndpoint { get; }

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

Property Value
Type Description
string

DefaultScopes

public static IReadOnlyList<string> DefaultScopes { get; }

The default DataConnectorService scopes.

Property Value
Type Description
IReadOnlyListstring
Remarks

The default DataConnectorService scopes are:

GrpcClient

public virtual DataConnectorService.DataConnectorServiceClient GrpcClient { get; }

The underlying gRPC DataConnectorService client

Property Value
Type Description
DataConnectorServiceDataConnectorServiceClient

LocationsClient

public virtual LocationsClient LocationsClient { get; }

The LocationsClient associated with this client.

Property Value
Type Description
LocationsClient

ServiceMetadata

public static ServiceMetadata ServiceMetadata { get; }

The service metadata associated with this client type.

Property Value
Type Description
ServiceMetadata

SetUpDataConnectorOperationsClient

public virtual OperationsClient SetUpDataConnectorOperationsClient { get; }

The long-running operations client for SetUpDataConnector.

Property Value
Type Description
OperationsClient

Methods

Create()

public static DataConnectorServiceClient Create()

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

Returns
Type Description
DataConnectorServiceClient

The created DataConnectorServiceClient.

CreateAsync(CancellationToken)

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

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

Parameter
Name Description
cancellationToken CancellationToken

The CancellationToken to use while creating the client.
Returns
Type Description
TaskDataConnectorServiceClient

The task representing the created DataConnectorServiceClient.

GetDataConnector(DataConnectorName, CallSettings)

public virtual DataConnector GetDataConnector(DataConnectorName name, CallSettings callSettings = null)

Gets the [DataConnector][google.cloud.discoveryengine.v1.DataConnector]. [DataConnector][google.cloud.discoveryengine.v1.DataConnector] is a singleton resource for each [Collection][google.cloud.discoveryengine.v1.Collection].

Parameters
Name Description
name DataConnectorName

Required. Full resource name of [DataConnector][google.cloud.discoveryengine.v1.DataConnector], such as projects/{project}/locations/{location}/collections/{collection_id}/dataConnector.

If the caller does not have permission to access the [DataConnector][google.cloud.discoveryengine.v1.DataConnector], regardless of whether or not it exists, a PERMISSION_DENIED error is returned.

If the requested [DataConnector][google.cloud.discoveryengine.v1.DataConnector] does not exist, a NOT_FOUND error is returned.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
DataConnector

The RPC response.
Example 
// Create client
DataConnectorServiceClient dataConnectorServiceClient = DataConnectorServiceClient.Create();
// Initialize request argument(s)
DataConnectorName name = DataConnectorName.FromProjectLocationCollection("[PROJECT]", "[LOCATION]", "[COLLECTION]");
// Make the request
DataConnector response = dataConnectorServiceClient.GetDataConnector(name);

GetDataConnector(GetDataConnectorRequest, CallSettings)

public virtual DataConnector GetDataConnector(GetDataConnectorRequest request, CallSettings callSettings = null)

Gets the [DataConnector][google.cloud.discoveryengine.v1.DataConnector]. [DataConnector][google.cloud.discoveryengine.v1.DataConnector] is a singleton resource for each [Collection][google.cloud.discoveryengine.v1.Collection].

Parameters
Name Description
request GetDataConnectorRequest

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
DataConnector

The RPC response.
Example 
// Create client
DataConnectorServiceClient dataConnectorServiceClient = DataConnectorServiceClient.Create();
// Initialize request argument(s)
GetDataConnectorRequest request = new GetDataConnectorRequest
{
    DataConnectorName = DataConnectorName.FromProjectLocationCollection("[PROJECT]", "[LOCATION]", "[COLLECTION]"),
};
// Make the request
DataConnector response = dataConnectorServiceClient.GetDataConnector(request);

GetDataConnector(string, CallSettings)

public virtual DataConnector GetDataConnector(string name, CallSettings callSettings = null)

Gets the [DataConnector][google.cloud.discoveryengine.v1.DataConnector]. [DataConnector][google.cloud.discoveryengine.v1.DataConnector] is a singleton resource for each [Collection][google.cloud.discoveryengine.v1.Collection].

Parameters
Name Description
name string

Required. Full resource name of [DataConnector][google.cloud.discoveryengine.v1.DataConnector], such as projects/{project}/locations/{location}/collections/{collection_id}/dataConnector.

If the caller does not have permission to access the [DataConnector][google.cloud.discoveryengine.v1.DataConnector], regardless of whether or not it exists, a PERMISSION_DENIED error is returned.

If the requested [DataConnector][google.cloud.discoveryengine.v1.DataConnector] does not exist, a NOT_FOUND error is returned.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
DataConnector

The RPC response.
Example 
// Create client
DataConnectorServiceClient dataConnectorServiceClient = DataConnectorServiceClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/collections/[COLLECTION]/dataConnector";
// Make the request
DataConnector response = dataConnectorServiceClient.GetDataConnector(name);

GetDataConnectorAsync(DataConnectorName, CallSettings)

public virtual Task<DataConnector> GetDataConnectorAsync(DataConnectorName name, CallSettings callSettings = null)

Gets the [DataConnector][google.cloud.discoveryengine.v1.DataConnector]. [DataConnector][google.cloud.discoveryengine.v1.DataConnector] is a singleton resource for each [Collection][google.cloud.discoveryengine.v1.Collection].

Parameters
Name Description
name DataConnectorName

Required. Full resource name of [DataConnector][google.cloud.discoveryengine.v1.DataConnector], such as projects/{project}/locations/{location}/collections/{collection_id}/dataConnector.

If the caller does not have permission to access the [DataConnector][google.cloud.discoveryengine.v1.DataConnector], regardless of whether or not it exists, a PERMISSION_DENIED error is returned.

If the requested [DataConnector][google.cloud.discoveryengine.v1.DataConnector] does not exist, a NOT_FOUND error is returned.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskDataConnector

A Task containing the RPC response.
Example 
// Create client
DataConnectorServiceClient dataConnectorServiceClient = await DataConnectorServiceClient.CreateAsync();
// Initialize request argument(s)
DataConnectorName name = DataConnectorName.FromProjectLocationCollection("[PROJECT]", "[LOCATION]", "[COLLECTION]");
// Make the request
DataConnector response = await dataConnectorServiceClient.GetDataConnectorAsync(name);

GetDataConnectorAsync(DataConnectorName, CancellationToken)

public virtual Task<DataConnector> GetDataConnectorAsync(DataConnectorName name, CancellationToken cancellationToken)

Gets the [DataConnector][google.cloud.discoveryengine.v1.DataConnector]. [DataConnector][google.cloud.discoveryengine.v1.DataConnector] is a singleton resource for each [Collection][google.cloud.discoveryengine.v1.Collection].

Parameters
Name Description
name DataConnectorName

Required. Full resource name of [DataConnector][google.cloud.discoveryengine.v1.DataConnector], such as projects/{project}/locations/{location}/collections/{collection_id}/dataConnector.

If the caller does not have permission to access the [DataConnector][google.cloud.discoveryengine.v1.DataConnector], regardless of whether or not it exists, a PERMISSION_DENIED error is returned.

If the requested [DataConnector][google.cloud.discoveryengine.v1.DataConnector] does not exist, a NOT_FOUND error is returned.
cancellationToken CancellationToken

A CancellationToken to use for this RPC.
Returns
Type Description
TaskDataConnector

A Task containing the RPC response.
Example 
// Create client
DataConnectorServiceClient dataConnectorServiceClient = await DataConnectorServiceClient.CreateAsync();
// Initialize request argument(s)
DataConnectorName name = DataConnectorName.FromProjectLocationCollection("[PROJECT]", "[LOCATION]", "[COLLECTION]");
// Make the request
DataConnector response = await dataConnectorServiceClient.GetDataConnectorAsync(name);

GetDataConnectorAsync(GetDataConnectorRequest, CallSettings)

public virtual Task<DataConnector> GetDataConnectorAsync(GetDataConnectorRequest request, CallSettings callSettings = null)

Gets the [DataConnector][google.cloud.discoveryengine.v1.DataConnector]. [DataConnector][google.cloud.discoveryengine.v1.DataConnector] is a singleton resource for each [Collection][google.cloud.discoveryengine.v1.Collection].

Parameters
Name Description
request GetDataConnectorRequest

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
TaskDataConnector

A Task containing the RPC response.
Example 
// Create client
DataConnectorServiceClient dataConnectorServiceClient = await DataConnectorServiceClient.CreateAsync();
// Initialize request argument(s)
GetDataConnectorRequest request = new GetDataConnectorRequest
{
    DataConnectorName = DataConnectorName.FromProjectLocationCollection("[PROJECT]", "[LOCATION]", "[COLLECTION]"),
};
// Make the request
DataConnector response = await dataConnectorServiceClient.GetDataConnectorAsync(request);

GetDataConnectorAsync(GetDataConnectorRequest, CancellationToken)

public virtual Task<DataConnector> GetDataConnectorAsync(GetDataConnectorRequest request, CancellationToken cancellationToken)

Gets the [DataConnector][google.cloud.discoveryengine.v1.DataConnector]. [DataConnector][google.cloud.discoveryengine.v1.DataConnector] is a singleton resource for each [Collection][google.cloud.discoveryengine.v1.Collection].

Parameters
Name Description
request GetDataConnectorRequest

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

A CancellationToken to use for this RPC.
Returns
Type Description
TaskDataConnector

A Task containing the RPC response.
Example 
// Create client
DataConnectorServiceClient dataConnectorServiceClient = await DataConnectorServiceClient.CreateAsync();
// Initialize request argument(s)
GetDataConnectorRequest request = new GetDataConnectorRequest
{
    DataConnectorName = DataConnectorName.FromProjectLocationCollection("[PROJECT]", "[LOCATION]", "[COLLECTION]"),
};
// Make the request
DataConnector response = await dataConnectorServiceClient.GetDataConnectorAsync(request);

GetDataConnectorAsync(string, CallSettings)

public virtual Task<DataConnector> GetDataConnectorAsync(string name, CallSettings callSettings = null)

Gets the [DataConnector][google.cloud.discoveryengine.v1.DataConnector]. [DataConnector][google.cloud.discoveryengine.v1.DataConnector] is a singleton resource for each [Collection][google.cloud.discoveryengine.v1.Collection].

Parameters
Name Description
name string

Required. Full resource name of [DataConnector][google.cloud.discoveryengine.v1.DataConnector], such as projects/{project}/locations/{location}/collections/{collection_id}/dataConnector.

If the caller does not have permission to access the [DataConnector][google.cloud.discoveryengine.v1.DataConnector], regardless of whether or not it exists, a PERMISSION_DENIED error is returned.

If the requested [DataConnector][google.cloud.discoveryengine.v1.DataConnector] does not exist, a NOT_FOUND error is returned.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskDataConnector

A Task containing the RPC response.
Example 
// Create client
DataConnectorServiceClient dataConnectorServiceClient = await DataConnectorServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/collections/[COLLECTION]/dataConnector";
// Make the request
DataConnector response = await dataConnectorServiceClient.GetDataConnectorAsync(name);

GetDataConnectorAsync(string, CancellationToken)

public virtual Task<DataConnector> GetDataConnectorAsync(string name, CancellationToken cancellationToken)

Gets the [DataConnector][google.cloud.discoveryengine.v1.DataConnector]. [DataConnector][google.cloud.discoveryengine.v1.DataConnector] is a singleton resource for each [Collection][google.cloud.discoveryengine.v1.Collection].

Parameters
Name Description
name string

Required. Full resource name of [DataConnector][google.cloud.discoveryengine.v1.DataConnector], such as projects/{project}/locations/{location}/collections/{collection_id}/dataConnector.

If the caller does not have permission to access the [DataConnector][google.cloud.discoveryengine.v1.DataConnector], regardless of whether or not it exists, a PERMISSION_DENIED error is returned.

If the requested [DataConnector][google.cloud.discoveryengine.v1.DataConnector] does not exist, a NOT_FOUND error is returned.
cancellationToken CancellationToken

A CancellationToken to use for this RPC.
Returns
Type Description
TaskDataConnector

A Task containing the RPC response.
Example 
// Create client
DataConnectorServiceClient dataConnectorServiceClient = await DataConnectorServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/collections/[COLLECTION]/dataConnector";
// Make the request
DataConnector response = await dataConnectorServiceClient.GetDataConnectorAsync(name);

PollOnceSetUpDataConnector(string, CallSettings)

public virtual Operation<DataConnector, SetUpDataConnectorMetadata> PollOnceSetUpDataConnector(string operationName, CallSettings callSettings = null)

Poll an operation once, using an operationName from a previous invocation of SetUpDataConnector .

Parameters
Name Description
operationName string

The name of a previously invoked operation. Must not be null or empty.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationDataConnectorSetUpDataConnectorMetadata

The result of polling the operation.

PollOnceSetUpDataConnectorAsync(string, CallSettings)

public virtual Task<Operation<DataConnector, SetUpDataConnectorMetadata>> PollOnceSetUpDataConnectorAsync(string operationName, CallSettings callSettings = null)

Asynchronously poll an operation once, using an operationName from a previous invocation of SetUpDataConnector.

Parameters
Name Description
operationName string

The name of a previously invoked operation. Must not be null or empty.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationDataConnectorSetUpDataConnectorMetadata

A task representing the result of polling the operation.

SetUpDataConnector(LocationName, string, string, DataConnector, CallSettings)

public virtual Operation<DataConnector, SetUpDataConnectorMetadata> SetUpDataConnector(LocationName parent, string collectionId, string collectionDisplayName, DataConnector dataConnector, CallSettings callSettings = null)

Creates a [Collection][google.cloud.discoveryengine.v1.Collection] and sets up the [DataConnector][google.cloud.discoveryengine.v1.DataConnector] for it. To stop a [DataConnector][google.cloud.discoveryengine.v1.DataConnector] after setup, use the [CollectionService.DeleteCollection][google.cloud.discoveryengine.v1.CollectionService.DeleteCollection] method.

Parameters
Name Description
parent LocationName

Required. The parent of [Collection][google.cloud.discoveryengine.v1.Collection], in the format of projects/{project}/locations/{location}.
collectionId string

Required. The ID to use for the [Collection][google.cloud.discoveryengine.v1.Collection], which will become the final component of the [Collection][google.cloud.discoveryengine.v1.Collection]'s resource name. A new [Collection][google.cloud.discoveryengine.v1.Collection] is created as part of the [DataConnector][google.cloud.discoveryengine.v1.DataConnector] setup. [DataConnector][google.cloud.discoveryengine.v1.DataConnector] is a singleton resource under [Collection][google.cloud.discoveryengine.v1.Collection], managing all [DataStore][google.cloud.discoveryengine.v1.DataStore]s of the [Collection][google.cloud.discoveryengine.v1.Collection].

Should conform to RFC-1034 standard with a length limit of 63 characters. Otherwise, an INVALID_ARGUMENT error is returned.
collectionDisplayName string

Required. The display name of the [Collection][google.cloud.discoveryengine.v1.Collection].

Should be human readable, used to display collections in the Console Dashboard. UTF-8 encoded string with limit of 1024 characters.
dataConnector DataConnector

Required. The [DataConnector][google.cloud.discoveryengine.v1.DataConnector] to initialize in the newly created [Collection][google.cloud.discoveryengine.v1.Collection].
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationDataConnectorSetUpDataConnectorMetadata

The RPC response.
Example 
// Create client
DataConnectorServiceClient dataConnectorServiceClient = DataConnectorServiceClient.Create();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
string collectionId = "";
string collectionDisplayName = "";
DataConnector dataConnector = new DataConnector();
// Make the request
Operation<DataConnector, SetUpDataConnectorMetadata> response = dataConnectorServiceClient.SetUpDataConnector(parent, collectionId, collectionDisplayName, dataConnector);

// Poll until the returned long-running operation is complete
Operation<DataConnector, SetUpDataConnectorMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
DataConnector result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<DataConnector, SetUpDataConnectorMetadata> retrievedResponse = dataConnectorServiceClient.PollOnceSetUpDataConnector(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    DataConnector retrievedResult = retrievedResponse.Result;
}

SetUpDataConnector(SetUpDataConnectorRequest, CallSettings)

public virtual Operation<DataConnector, SetUpDataConnectorMetadata> SetUpDataConnector(SetUpDataConnectorRequest request, CallSettings callSettings = null)

Creates a [Collection][google.cloud.discoveryengine.v1.Collection] and sets up the [DataConnector][google.cloud.discoveryengine.v1.DataConnector] for it. To stop a [DataConnector][google.cloud.discoveryengine.v1.DataConnector] after setup, use the [CollectionService.DeleteCollection][google.cloud.discoveryengine.v1.CollectionService.DeleteCollection] method.

Parameters
Name Description
request SetUpDataConnectorRequest

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
OperationDataConnectorSetUpDataConnectorMetadata

The RPC response.
Example 
// Create client
DataConnectorServiceClient dataConnectorServiceClient = DataConnectorServiceClient.Create();
// Initialize request argument(s)
SetUpDataConnectorRequest request = new SetUpDataConnectorRequest
{
    ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
    CollectionId = "",
    CollectionDisplayName = "",
    DataConnector = new DataConnector(),
};
// Make the request
Operation<DataConnector, SetUpDataConnectorMetadata> response = dataConnectorServiceClient.SetUpDataConnector(request);

// Poll until the returned long-running operation is complete
Operation<DataConnector, SetUpDataConnectorMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
DataConnector result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<DataConnector, SetUpDataConnectorMetadata> retrievedResponse = dataConnectorServiceClient.PollOnceSetUpDataConnector(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    DataConnector retrievedResult = retrievedResponse.Result;
}

SetUpDataConnector(string, string, string, DataConnector, CallSettings)

public virtual Operation<DataConnector, SetUpDataConnectorMetadata> SetUpDataConnector(string parent, string collectionId, string collectionDisplayName, DataConnector dataConnector, CallSettings callSettings = null)

Creates a [Collection][google.cloud.discoveryengine.v1.Collection] and sets up the [DataConnector][google.cloud.discoveryengine.v1.DataConnector] for it. To stop a [DataConnector][google.cloud.discoveryengine.v1.DataConnector] after setup, use the [CollectionService.DeleteCollection][google.cloud.discoveryengine.v1.CollectionService.DeleteCollection] method.

Parameters
Name Description
parent string

Required. The parent of [Collection][google.cloud.discoveryengine.v1.Collection], in the format of projects/{project}/locations/{location}.
collectionId string

Required. The ID to use for the [Collection][google.cloud.discoveryengine.v1.Collection], which will become the final component of the [Collection][google.cloud.discoveryengine.v1.Collection]'s resource name. A new [Collection][google.cloud.discoveryengine.v1.Collection] is created as part of the [DataConnector][google.cloud.discoveryengine.v1.DataConnector] setup. [DataConnector][google.cloud.discoveryengine.v1.DataConnector] is a singleton resource under [Collection][google.cloud.discoveryengine.v1.Collection], managing all [DataStore][google.cloud.discoveryengine.v1.DataStore]s of the [Collection][google.cloud.discoveryengine.v1.Collection].

Should conform to RFC-1034 standard with a length limit of 63 characters. Otherwise, an INVALID_ARGUMENT error is returned.
collectionDisplayName string

Required. The display name of the [Collection][google.cloud.discoveryengine.v1.Collection].

Should be human readable, used to display collections in the Console Dashboard. UTF-8 encoded string with limit of 1024 characters.
dataConnector DataConnector

Required. The [DataConnector][google.cloud.discoveryengine.v1.DataConnector] to initialize in the newly created [Collection][google.cloud.discoveryengine.v1.Collection].
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationDataConnectorSetUpDataConnectorMetadata

The RPC response.
Example 
// Create client
DataConnectorServiceClient dataConnectorServiceClient = DataConnectorServiceClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
string collectionId = "";
string collectionDisplayName = "";
DataConnector dataConnector = new DataConnector();
// Make the request
Operation<DataConnector, SetUpDataConnectorMetadata> response = dataConnectorServiceClient.SetUpDataConnector(parent, collectionId, collectionDisplayName, dataConnector);

// Poll until the returned long-running operation is complete
Operation<DataConnector, SetUpDataConnectorMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
DataConnector result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<DataConnector, SetUpDataConnectorMetadata> retrievedResponse = dataConnectorServiceClient.PollOnceSetUpDataConnector(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    DataConnector retrievedResult = retrievedResponse.Result;
}

SetUpDataConnectorAsync(LocationName, string, string, DataConnector, CallSettings)

public virtual Task<Operation<DataConnector, SetUpDataConnectorMetadata>> SetUpDataConnectorAsync(LocationName parent, string collectionId, string collectionDisplayName, DataConnector dataConnector, CallSettings callSettings = null)

Creates a [Collection][google.cloud.discoveryengine.v1.Collection] and sets up the [DataConnector][google.cloud.discoveryengine.v1.DataConnector] for it. To stop a [DataConnector][google.cloud.discoveryengine.v1.DataConnector] after setup, use the [CollectionService.DeleteCollection][google.cloud.discoveryengine.v1.CollectionService.DeleteCollection] method.

Parameters
Name Description
parent LocationName

Required. The parent of [Collection][google.cloud.discoveryengine.v1.Collection], in the format of projects/{project}/locations/{location}.
collectionId string

Required. The ID to use for the [Collection][google.cloud.discoveryengine.v1.Collection], which will become the final component of the [Collection][google.cloud.discoveryengine.v1.Collection]'s resource name. A new [Collection][google.cloud.discoveryengine.v1.Collection] is created as part of the [DataConnector][google.cloud.discoveryengine.v1.DataConnector] setup. [DataConnector][google.cloud.discoveryengine.v1.DataConnector] is a singleton resource under [Collection][google.cloud.discoveryengine.v1.Collection], managing all [DataStore][google.cloud.discoveryengine.v1.DataStore]s of the [Collection][google.cloud.discoveryengine.v1.Collection].

Should conform to RFC-1034 standard with a length limit of 63 characters. Otherwise, an INVALID_ARGUMENT error is returned.
collectionDisplayName string

Required. The display name of the [Collection][google.cloud.discoveryengine.v1.Collection].

Should be human readable, used to display collections in the Console Dashboard. UTF-8 encoded string with limit of 1024 characters.
dataConnector DataConnector

Required. The [DataConnector][google.cloud.discoveryengine.v1.DataConnector] to initialize in the newly created [Collection][google.cloud.discoveryengine.v1.Collection].
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationDataConnectorSetUpDataConnectorMetadata

A Task containing the RPC response.
Example 
// Create client
DataConnectorServiceClient dataConnectorServiceClient = await DataConnectorServiceClient.CreateAsync();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
string collectionId = "";
string collectionDisplayName = "";
DataConnector dataConnector = new DataConnector();
// Make the request
Operation<DataConnector, SetUpDataConnectorMetadata> response = await dataConnectorServiceClient.SetUpDataConnectorAsync(parent, collectionId, collectionDisplayName, dataConnector);

// Poll until the returned long-running operation is complete
Operation<DataConnector, SetUpDataConnectorMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
DataConnector result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<DataConnector, SetUpDataConnectorMetadata> retrievedResponse = await dataConnectorServiceClient.PollOnceSetUpDataConnectorAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    DataConnector retrievedResult = retrievedResponse.Result;
}

SetUpDataConnectorAsync(LocationName, string, string, DataConnector, CancellationToken)

public virtual Task<Operation<DataConnector, SetUpDataConnectorMetadata>> SetUpDataConnectorAsync(LocationName parent, string collectionId, string collectionDisplayName, DataConnector dataConnector, CancellationToken cancellationToken)

Creates a [Collection][google.cloud.discoveryengine.v1.Collection] and sets up the [DataConnector][google.cloud.discoveryengine.v1.DataConnector] for it. To stop a [DataConnector][google.cloud.discoveryengine.v1.DataConnector] after setup, use the [CollectionService.DeleteCollection][google.cloud.discoveryengine.v1.CollectionService.DeleteCollection] method.

Parameters
Name Description
parent LocationName

Required. The parent of [Collection][google.cloud.discoveryengine.v1.Collection], in the format of projects/{project}/locations/{location}.
collectionId string

Required. The ID to use for the [Collection][google.cloud.discoveryengine.v1.Collection], which will become the final component of the [Collection][google.cloud.discoveryengine.v1.Collection]'s resource name. A new [Collection][google.cloud.discoveryengine.v1.Collection] is created as part of the [DataConnector][google.cloud.discoveryengine.v1.DataConnector] setup. [DataConnector][google.cloud.discoveryengine.v1.DataConnector] is a singleton resource under [Collection][google.cloud.discoveryengine.v1.Collection], managing all [DataStore][google.cloud.discoveryengine.v1.DataStore]s of the [Collection][google.cloud.discoveryengine.v1.Collection].

Should conform to RFC-1034 standard with a length limit of 63 characters. Otherwise, an INVALID_ARGUMENT error is returned.
collectionDisplayName string

Required. The display name of the [Collection][google.cloud.discoveryengine.v1.Collection].

Should be human readable, used to display collections in the Console Dashboard. UTF-8 encoded string with limit of 1024 characters.
dataConnector DataConnector

Required. The [DataConnector][google.cloud.discoveryengine.v1.DataConnector] to initialize in the newly created [Collection][google.cloud.discoveryengine.v1.Collection].
cancellationToken CancellationToken

A CancellationToken to use for this RPC.
Returns
Type Description
TaskOperationDataConnectorSetUpDataConnectorMetadata

A Task containing the RPC response.
Example 
// Create client
DataConnectorServiceClient dataConnectorServiceClient = await DataConnectorServiceClient.CreateAsync();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
string collectionId = "";
string collectionDisplayName = "";
DataConnector dataConnector = new DataConnector();
// Make the request
Operation<DataConnector, SetUpDataConnectorMetadata> response = await dataConnectorServiceClient.SetUpDataConnectorAsync(parent, collectionId, collectionDisplayName, dataConnector);

// Poll until the returned long-running operation is complete
Operation<DataConnector, SetUpDataConnectorMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
DataConnector result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<DataConnector, SetUpDataConnectorMetadata> retrievedResponse = await dataConnectorServiceClient.PollOnceSetUpDataConnectorAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    DataConnector retrievedResult = retrievedResponse.Result;
}

SetUpDataConnectorAsync(SetUpDataConnectorRequest, CallSettings)

public virtual Task<Operation<DataConnector, SetUpDataConnectorMetadata>> SetUpDataConnectorAsync(SetUpDataConnectorRequest request, CallSettings callSettings = null)

Creates a [Collection][google.cloud.discoveryengine.v1.Collection] and sets up the [DataConnector][google.cloud.discoveryengine.v1.DataConnector] for it. To stop a [DataConnector][google.cloud.discoveryengine.v1.DataConnector] after setup, use the [CollectionService.DeleteCollection][google.cloud.discoveryengine.v1.CollectionService.DeleteCollection] method.

Parameters
Name Description
request SetUpDataConnectorRequest

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
TaskOperationDataConnectorSetUpDataConnectorMetadata

A Task containing the RPC response.
Example 
// Create client
DataConnectorServiceClient dataConnectorServiceClient = await DataConnectorServiceClient.CreateAsync();
// Initialize request argument(s)
SetUpDataConnectorRequest request = new SetUpDataConnectorRequest
{
    ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
    CollectionId = "",
    CollectionDisplayName = "",
    DataConnector = new DataConnector(),
};
// Make the request
Operation<DataConnector, SetUpDataConnectorMetadata> response = await dataConnectorServiceClient.SetUpDataConnectorAsync(request);

// Poll until the returned long-running operation is complete
Operation<DataConnector, SetUpDataConnectorMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
DataConnector result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<DataConnector, SetUpDataConnectorMetadata> retrievedResponse = await dataConnectorServiceClient.PollOnceSetUpDataConnectorAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    DataConnector retrievedResult = retrievedResponse.Result;
}

SetUpDataConnectorAsync(SetUpDataConnectorRequest, CancellationToken)

public virtual Task<Operation<DataConnector, SetUpDataConnectorMetadata>> SetUpDataConnectorAsync(SetUpDataConnectorRequest request, CancellationToken cancellationToken)

Creates a [Collection][google.cloud.discoveryengine.v1.Collection] and sets up the [DataConnector][google.cloud.discoveryengine.v1.DataConnector] for it. To stop a [DataConnector][google.cloud.discoveryengine.v1.DataConnector] after setup, use the [CollectionService.DeleteCollection][google.cloud.discoveryengine.v1.CollectionService.DeleteCollection] method.

Parameters
Name Description
request SetUpDataConnectorRequest

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

A CancellationToken to use for this RPC.
Returns
Type Description
TaskOperationDataConnectorSetUpDataConnectorMetadata

A Task containing the RPC response.
Example 
// Create client
DataConnectorServiceClient dataConnectorServiceClient = await DataConnectorServiceClient.CreateAsync();
// Initialize request argument(s)
SetUpDataConnectorRequest request = new SetUpDataConnectorRequest
{
    ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
    CollectionId = "",
    CollectionDisplayName = "",
    DataConnector = new DataConnector(),
};
// Make the request
Operation<DataConnector, SetUpDataConnectorMetadata> response = await dataConnectorServiceClient.SetUpDataConnectorAsync(request);

// Poll until the returned long-running operation is complete
Operation<DataConnector, SetUpDataConnectorMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
DataConnector result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<DataConnector, SetUpDataConnectorMetadata> retrievedResponse = await dataConnectorServiceClient.PollOnceSetUpDataConnectorAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    DataConnector retrievedResult = retrievedResponse.Result;
}

SetUpDataConnectorAsync(string, string, string, DataConnector, CallSettings)

public virtual Task<Operation<DataConnector, SetUpDataConnectorMetadata>> SetUpDataConnectorAsync(string parent, string collectionId, string collectionDisplayName, DataConnector dataConnector, CallSettings callSettings = null)

Creates a [Collection][google.cloud.discoveryengine.v1.Collection] and sets up the [DataConnector][google.cloud.discoveryengine.v1.DataConnector] for it. To stop a [DataConnector][google.cloud.discoveryengine.v1.DataConnector] after setup, use the [CollectionService.DeleteCollection][google.cloud.discoveryengine.v1.CollectionService.DeleteCollection] method.

Parameters
Name Description
parent string

Required. The parent of [Collection][google.cloud.discoveryengine.v1.Collection], in the format of projects/{project}/locations/{location}.
collectionId string

Required. The ID to use for the [Collection][google.cloud.discoveryengine.v1.Collection], which will become the final component of the [Collection][google.cloud.discoveryengine.v1.Collection]'s resource name. A new [Collection][google.cloud.discoveryengine.v1.Collection] is created as part of the [DataConnector][google.cloud.discoveryengine.v1.DataConnector] setup. [DataConnector][google.cloud.discoveryengine.v1.DataConnector] is a singleton resource under [Collection][google.cloud.discoveryengine.v1.Collection], managing all [DataStore][google.cloud.discoveryengine.v1.DataStore]s of the [Collection][google.cloud.discoveryengine.v1.Collection].

Should conform to RFC-1034 standard with a length limit of 63 characters. Otherwise, an INVALID_ARGUMENT error is returned.
collectionDisplayName string

Required. The display name of the [Collection][google.cloud.discoveryengine.v1.Collection].

Should be human readable, used to display collections in the Console Dashboard. UTF-8 encoded string with limit of 1024 characters.
dataConnector DataConnector

Required. The [DataConnector][google.cloud.discoveryengine.v1.DataConnector] to initialize in the newly created [Collection][google.cloud.discoveryengine.v1.Collection].
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationDataConnectorSetUpDataConnectorMetadata

A Task containing the RPC response.
Example 
// Create client
DataConnectorServiceClient dataConnectorServiceClient = await DataConnectorServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
string collectionId = "";
string collectionDisplayName = "";
DataConnector dataConnector = new DataConnector();
// Make the request
Operation<DataConnector, SetUpDataConnectorMetadata> response = await dataConnectorServiceClient.SetUpDataConnectorAsync(parent, collectionId, collectionDisplayName, dataConnector);

// Poll until the returned long-running operation is complete
Operation<DataConnector, SetUpDataConnectorMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
DataConnector result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<DataConnector, SetUpDataConnectorMetadata> retrievedResponse = await dataConnectorServiceClient.PollOnceSetUpDataConnectorAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    DataConnector retrievedResult = retrievedResponse.Result;
}

SetUpDataConnectorAsync(string, string, string, DataConnector, CancellationToken)

public virtual Task<Operation<DataConnector, SetUpDataConnectorMetadata>> SetUpDataConnectorAsync(string parent, string collectionId, string collectionDisplayName, DataConnector dataConnector, CancellationToken cancellationToken)

Creates a [Collection][google.cloud.discoveryengine.v1.Collection] and sets up the [DataConnector][google.cloud.discoveryengine.v1.DataConnector] for it. To stop a [DataConnector][google.cloud.discoveryengine.v1.DataConnector] after setup, use the [CollectionService.DeleteCollection][google.cloud.discoveryengine.v1.CollectionService.DeleteCollection] method.

Parameters
Name Description
parent string

Required. The parent of [Collection][google.cloud.discoveryengine.v1.Collection], in the format of projects/{project}/locations/{location}.
collectionId string

Required. The ID to use for the [Collection][google.cloud.discoveryengine.v1.Collection], which will become the final component of the [Collection][google.cloud.discoveryengine.v1.Collection]'s resource name. A new [Collection][google.cloud.discoveryengine.v1.Collection] is created as part of the [DataConnector][google.cloud.discoveryengine.v1.DataConnector] setup. [DataConnector][google.cloud.discoveryengine.v1.DataConnector] is a singleton resource under [Collection][google.cloud.discoveryengine.v1.Collection], managing all [DataStore][google.cloud.discoveryengine.v1.DataStore]s of the [Collection][google.cloud.discoveryengine.v1.Collection].

Should conform to RFC-1034 standard with a length limit of 63 characters. Otherwise, an INVALID_ARGUMENT error is returned.
collectionDisplayName string

Required. The display name of the [Collection][google.cloud.discoveryengine.v1.Collection].

Should be human readable, used to display collections in the Console Dashboard. UTF-8 encoded string with limit of 1024 characters.
dataConnector DataConnector

Required. The [DataConnector][google.cloud.discoveryengine.v1.DataConnector] to initialize in the newly created [Collection][google.cloud.discoveryengine.v1.Collection].
cancellationToken CancellationToken

A CancellationToken to use for this RPC.
Returns
Type Description
TaskOperationDataConnectorSetUpDataConnectorMetadata

A Task containing the RPC response.
Example 
// Create client
DataConnectorServiceClient dataConnectorServiceClient = await DataConnectorServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
string collectionId = "";
string collectionDisplayName = "";
DataConnector dataConnector = new DataConnector();
// Make the request
Operation<DataConnector, SetUpDataConnectorMetadata> response = await dataConnectorServiceClient.SetUpDataConnectorAsync(parent, collectionId, collectionDisplayName, dataConnector);

// Poll until the returned long-running operation is complete
Operation<DataConnector, SetUpDataConnectorMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
DataConnector result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<DataConnector, SetUpDataConnectorMetadata> retrievedResponse = await dataConnectorServiceClient.PollOnceSetUpDataConnectorAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    DataConnector retrievedResult = retrievedResponse.Result;
}

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.

UpdateDataConnector(DataConnector, FieldMask, CallSettings)

public virtual DataConnector UpdateDataConnector(DataConnector dataConnector, FieldMask updateMask, CallSettings callSettings = null)

Updates a [DataConnector][google.cloud.discoveryengine.v1.DataConnector].

Parameters
Name Description
dataConnector DataConnector

Required. The [DataConnector][google.cloud.discoveryengine.v1.DataConnector] to update.

If the caller does not have permission to update the [DataConnector][google.cloud.discoveryengine.v1.DataConnector], regardless of whether or not it exists, a PERMISSION_DENIED error is returned.

If the [DataConnector][google.cloud.discoveryengine.v1.DataConnector] does not exist, a NOT_FOUND error is returned.
updateMask FieldMask

Indicates which fields in the provided [DataConnector][google.cloud.discoveryengine.v1.DataConnector] to update.

Supported field paths include:

  • refresh_interval
  • params
  • auto_run_disabled
  • action_config
  • action_config.action_params
  • action_config.service_name
  • destination_configs
  • blocking_reasons
  • sync_mode
  • incremental_sync_disabled
  • incremental_refresh_interval
  • data_protection_policy

Note: Support for these fields may vary depending on the connector type. For example, not all connectors support destination_configs.

If an unsupported or unknown field path is provided, the request will return an INVALID_ARGUMENT error.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
DataConnector

The RPC response.
Example 
// Create client
DataConnectorServiceClient dataConnectorServiceClient = DataConnectorServiceClient.Create();
// Initialize request argument(s)
DataConnector dataConnector = new DataConnector();
FieldMask updateMask = new FieldMask();
// Make the request
DataConnector response = dataConnectorServiceClient.UpdateDataConnector(dataConnector, updateMask);

UpdateDataConnector(UpdateDataConnectorRequest, CallSettings)

public virtual DataConnector UpdateDataConnector(UpdateDataConnectorRequest request, CallSettings callSettings = null)

Updates a [DataConnector][google.cloud.discoveryengine.v1.DataConnector].

Parameters
Name Description
request UpdateDataConnectorRequest

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
DataConnector

The RPC response.
Example 
// Create client
DataConnectorServiceClient dataConnectorServiceClient = DataConnectorServiceClient.Create();
// Initialize request argument(s)
UpdateDataConnectorRequest request = new UpdateDataConnectorRequest
{
    DataConnector = new DataConnector(),
    UpdateMask = new FieldMask(),
};
// Make the request
DataConnector response = dataConnectorServiceClient.UpdateDataConnector(request);

UpdateDataConnectorAsync(DataConnector, FieldMask, CallSettings)

public virtual Task<DataConnector> UpdateDataConnectorAsync(DataConnector dataConnector, FieldMask updateMask, CallSettings callSettings = null)

Updates a [DataConnector][google.cloud.discoveryengine.v1.DataConnector].

Parameters
Name Description
dataConnector DataConnector

Required. The [DataConnector][google.cloud.discoveryengine.v1.DataConnector] to update.

If the caller does not have permission to update the [DataConnector][google.cloud.discoveryengine.v1.DataConnector], regardless of whether or not it exists, a PERMISSION_DENIED error is returned.

If the [DataConnector][google.cloud.discoveryengine.v1.DataConnector] does not exist, a NOT_FOUND error is returned.
updateMask FieldMask

Indicates which fields in the provided [DataConnector][google.cloud.discoveryengine.v1.DataConnector] to update.

Supported field paths include:

  • refresh_interval
  • params
  • auto_run_disabled
  • action_config
  • action_config.action_params
  • action_config.service_name
  • destination_configs
  • blocking_reasons
  • sync_mode
  • incremental_sync_disabled
  • incremental_refresh_interval
  • data_protection_policy

Note: Support for these fields may vary depending on the connector type. For example, not all connectors support destination_configs.

If an unsupported or unknown field path is provided, the request will return an INVALID_ARGUMENT error.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskDataConnector

A Task containing the RPC response.
Example 
// Create client
DataConnectorServiceClient dataConnectorServiceClient = await DataConnectorServiceClient.CreateAsync();
// Initialize request argument(s)
DataConnector dataConnector = new DataConnector();
FieldMask updateMask = new FieldMask();
// Make the request
DataConnector response = await dataConnectorServiceClient.UpdateDataConnectorAsync(dataConnector, updateMask);

UpdateDataConnectorAsync(DataConnector, FieldMask, CancellationToken)

public virtual Task<DataConnector> UpdateDataConnectorAsync(DataConnector dataConnector, FieldMask updateMask, CancellationToken cancellationToken)

Updates a [DataConnector][google.cloud.discoveryengine.v1.DataConnector].

Parameters
Name Description
dataConnector DataConnector

Required. The [DataConnector][google.cloud.discoveryengine.v1.DataConnector] to update.

If the caller does not have permission to update the [DataConnector][google.cloud.discoveryengine.v1.DataConnector], regardless of whether or not it exists, a PERMISSION_DENIED error is returned.

If the [DataConnector][google.cloud.discoveryengine.v1.DataConnector] does not exist, a NOT_FOUND error is returned.
updateMask FieldMask

Indicates which fields in the provided [DataConnector][google.cloud.discoveryengine.v1.DataConnector] to update.

Supported field paths include:

  • refresh_interval
  • params
  • auto_run_disabled
  • action_config
  • action_config.action_params
  • action_config.service_name
  • destination_configs
  • blocking_reasons
  • sync_mode
  • incremental_sync_disabled
  • incremental_refresh_interval
  • data_protection_policy

Note: Support for these fields may vary depending on the connector type. For example, not all connectors support destination_configs.

If an unsupported or unknown field path is provided, the request will return an INVALID_ARGUMENT error.
cancellationToken CancellationToken

A CancellationToken to use for this RPC.
Returns
Type Description
TaskDataConnector

A Task containing the RPC response.
Example 
// Create client
DataConnectorServiceClient dataConnectorServiceClient = await DataConnectorServiceClient.CreateAsync();
// Initialize request argument(s)
DataConnector dataConnector = new DataConnector();
FieldMask updateMask = new FieldMask();
// Make the request
DataConnector response = await dataConnectorServiceClient.UpdateDataConnectorAsync(dataConnector, updateMask);

UpdateDataConnectorAsync(UpdateDataConnectorRequest, CallSettings)

public virtual Task<DataConnector> UpdateDataConnectorAsync(UpdateDataConnectorRequest request, CallSettings callSettings = null)

Updates a [DataConnector][google.cloud.discoveryengine.v1.DataConnector].

Parameters
Name Description
request UpdateDataConnectorRequest

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
TaskDataConnector

A Task containing the RPC response.
Example 
// Create client
DataConnectorServiceClient dataConnectorServiceClient = await DataConnectorServiceClient.CreateAsync();
// Initialize request argument(s)
UpdateDataConnectorRequest request = new UpdateDataConnectorRequest
{
    DataConnector = new DataConnector(),
    UpdateMask = new FieldMask(),
};
// Make the request
DataConnector response = await dataConnectorServiceClient.UpdateDataConnectorAsync(request);

UpdateDataConnectorAsync(UpdateDataConnectorRequest, CancellationToken)

public virtual Task<DataConnector> UpdateDataConnectorAsync(UpdateDataConnectorRequest request, CancellationToken cancellationToken)

Updates a [DataConnector][google.cloud.discoveryengine.v1.DataConnector].

Parameters
Name Description
request UpdateDataConnectorRequest

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

A CancellationToken to use for this RPC.
Returns
Type Description
TaskDataConnector

A Task containing the RPC response.
Example 
// Create client
DataConnectorServiceClient dataConnectorServiceClient = await DataConnectorServiceClient.CreateAsync();
// Initialize request argument(s)
UpdateDataConnectorRequest request = new UpdateDataConnectorRequest
{
    DataConnector = new DataConnector(),
    UpdateMask = new FieldMask(),
};
// Make the request
DataConnector response = await dataConnectorServiceClient.UpdateDataConnectorAsync(request);