Discovery Engine v1 API - Class DataConnectorServiceClientImpl (1.17.0)

1.17.0 (latest) 1.16.0 1.15.0 1.14.0 1.13.0 1.12.0 1.11.0 1.10.0 1.9.0 1.8.0 1.7.0 1.6.0 1.5.0 1.4.0 1.3.0 1.2.0 1.1.0 1.0.0-beta06

public sealed class DataConnectorServiceClientImpl : DataConnectorServiceClient

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

DataConnectorService client wrapper implementation, for convenient use.

Inheritance

object > DataConnectorServiceClient > DataConnectorServiceClientImpl

Inherited Members

DataConnectorServiceClient.DefaultEndpoint

DataConnectorServiceClient.DefaultScopes

DataConnectorServiceClient.ServiceMetadata

DataConnectorServiceClient.CreateAsync(CancellationToken)

DataConnectorServiceClient.Create()

DataConnectorServiceClient.ShutdownDefaultChannelsAsync()

DataConnectorServiceClient.SetUpDataConnectorAsync(SetUpDataConnectorRequest, CancellationToken)

DataConnectorServiceClient.PollOnceSetUpDataConnector(string, CallSettings)

DataConnectorServiceClient.PollOnceSetUpDataConnectorAsync(string, CallSettings)

DataConnectorServiceClient.SetUpDataConnector(string, string, string, DataConnector, CallSettings)

DataConnectorServiceClient.SetUpDataConnectorAsync(string, string, string, DataConnector, CallSettings)

DataConnectorServiceClient.SetUpDataConnectorAsync(string, string, string, DataConnector, CancellationToken)

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

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

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

DataConnectorServiceClient.GetDataConnectorAsync(GetDataConnectorRequest, CancellationToken)

DataConnectorServiceClient.GetDataConnector(string, CallSettings)

DataConnectorServiceClient.GetDataConnectorAsync(string, CallSettings)

DataConnectorServiceClient.GetDataConnectorAsync(string, CancellationToken)

DataConnectorServiceClient.GetDataConnector(DataConnectorName, CallSettings)

DataConnectorServiceClient.GetDataConnectorAsync(DataConnectorName, CallSettings)

DataConnectorServiceClient.GetDataConnectorAsync(DataConnectorName, CancellationToken)

DataConnectorServiceClient.UpdateDataConnectorAsync(UpdateDataConnectorRequest, CancellationToken)

DataConnectorServiceClient.UpdateDataConnector(DataConnector, FieldMask, CallSettings)

DataConnectorServiceClient.UpdateDataConnectorAsync(DataConnector, FieldMask, CallSettings)

DataConnectorServiceClient.UpdateDataConnectorAsync(DataConnector, FieldMask, CancellationToken)

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

Google.Cloud.DiscoveryEngine.V1

Assembly

Google.Cloud.DiscoveryEngine.V1.dll

Remarks

Service for data connector management.

Constructors

DataConnectorServiceClientImpl(DataConnectorServiceClient, DataConnectorServiceSettings, ILogger)

public DataConnectorServiceClientImpl(DataConnectorService.DataConnectorServiceClient grpcClient, DataConnectorServiceSettings settings, ILogger logger)

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

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

Properties

GrpcClient

public override DataConnectorService.DataConnectorServiceClient GrpcClient { get; }

The underlying gRPC DataConnectorService client

Property Value
Type	Description
DataConnectorServiceDataConnectorServiceClient

Overrides

DataConnectorServiceClient.GrpcClient

LocationsClient

public override LocationsClient LocationsClient { get; }

The LocationsClient associated with this client.

Property Value
Type	Description
LocationsClient

Overrides

DataConnectorServiceClient.LocationsClient

SetUpDataConnectorOperationsClient

public override OperationsClient SetUpDataConnectorOperationsClient { get; }

The long-running operations client for SetUpDataConnector.

Property Value
Type	Description
OperationsClient

Overrides

DataConnectorServiceClient.SetUpDataConnectorOperationsClient

Methods

GetDataConnector(GetDataConnectorRequest, CallSettings)

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

Overrides

DataConnectorServiceClient.GetDataConnector(GetDataConnectorRequest, CallSettings)

GetDataConnectorAsync(GetDataConnectorRequest, CallSettings)

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

Overrides

DataConnectorServiceClient.GetDataConnectorAsync(GetDataConnectorRequest, CallSettings)

SetUpDataConnector(SetUpDataConnectorRequest, CallSettings)

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

Overrides

DataConnectorServiceClient.SetUpDataConnector(SetUpDataConnectorRequest, CallSettings)

SetUpDataConnectorAsync(SetUpDataConnectorRequest, CallSettings)

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

Overrides

DataConnectorServiceClient.SetUpDataConnectorAsync(SetUpDataConnectorRequest, CallSettings)

UpdateDataConnector(UpdateDataConnectorRequest, CallSettings)

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

Overrides

DataConnectorServiceClient.UpdateDataConnector(UpdateDataConnectorRequest, CallSettings)

UpdateDataConnectorAsync(UpdateDataConnectorRequest, CallSettings)

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

Overrides

DataConnectorServiceClient.UpdateDataConnectorAsync(UpdateDataConnectorRequest, CallSettings)