Discovery Engine v1 API - Class DataConnectorService.DataConnectorServiceClient (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 class DataConnectorService.DataConnectorServiceClient : ClientBase<DataConnectorService.DataConnectorServiceClient>

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

Client for DataConnectorService

Inheritance

object > ClientBase > ClientBaseDataConnectorServiceDataConnectorServiceClient > DataConnectorService.DataConnectorServiceClient

Inherited Members

ClientBase<DataConnectorService.DataConnectorServiceClient>.WithHost(string)

ClientBase.CallInvoker

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

Namespace

Google.Cloud.DiscoveryEngine.V1

Assembly

Google.Cloud.DiscoveryEngine.V1.dll

Constructors

DataConnectorServiceClient()

protected DataConnectorServiceClient()

Protected parameterless constructor to allow creation of test doubles.

DataConnectorServiceClient(CallInvoker)

public DataConnectorServiceClient(CallInvoker callInvoker)

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

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

DataConnectorServiceClient(ChannelBase)

public DataConnectorServiceClient(ChannelBase channel)

Creates a new client for DataConnectorService

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

DataConnectorServiceClient(ClientBaseConfiguration)

protected DataConnectorServiceClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
Name	Description
configuration	ClientBaseClientBaseConfiguration The client configuration.

Methods

CreateLocationsClient()

public virtual Locations.LocationsClient CreateLocationsClient()

Creates a new instance of Locations.LocationsClient using the same call invoker as this client.

Returns
Type	Description
LocationsLocationsClient	A new Locations.LocationsClient for the same target as this client.

CreateOperationsClient()

public virtual Operations.OperationsClient CreateOperationsClient()

Creates a new instance of Operations.OperationsClient using the same call invoker as this client.

Returns
Type	Description
OperationsOperationsClient	A new Operations client for the same target as this client.

GetDataConnector(GetDataConnectorRequest, CallOptions)

public virtual DataConnector GetDataConnector(GetDataConnectorRequest request, CallOptions options)

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

Returns
Type	Description
DataConnector	The response received from the server.

GetDataConnector(GetDataConnectorRequest, Metadata, DateTime?, CancellationToken)

public virtual DataConnector GetDataConnector(GetDataConnectorRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Returns
Type	Description
DataConnector	The response received from the server.

GetDataConnectorAsync(GetDataConnectorRequest, CallOptions)

public virtual AsyncUnaryCall<DataConnector> GetDataConnectorAsync(GetDataConnectorRequest request, CallOptions options)

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

Returns
Type	Description
AsyncUnaryCallDataConnector	The call object.

GetDataConnectorAsync(GetDataConnectorRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<DataConnector> GetDataConnectorAsync(GetDataConnectorRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Returns
Type	Description
AsyncUnaryCallDataConnector	The call object.

NewInstance(ClientBaseConfiguration)

protected override DataConnectorService.DataConnectorServiceClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
Name	Description
configuration	ClientBaseClientBaseConfiguration

Returns
Type	Description
DataConnectorServiceDataConnectorServiceClient

Overrides

Grpc.Core.ClientBase<Google.Cloud.DiscoveryEngine.V1.DataConnectorService.DataConnectorServiceClient>.NewInstance(Grpc.Core.ClientBase.ClientBaseConfiguration)

SetUpDataConnector(SetUpDataConnectorRequest, CallOptions)

public virtual Operation SetUpDataConnector(SetUpDataConnectorRequest request, CallOptions options)

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

Returns
Type	Description
Operation	The response received from the server.

SetUpDataConnector(SetUpDataConnectorRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation SetUpDataConnector(SetUpDataConnectorRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Returns
Type	Description
Operation	The response received from the server.

SetUpDataConnectorAsync(SetUpDataConnectorRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> SetUpDataConnectorAsync(SetUpDataConnectorRequest request, CallOptions options)

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

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

SetUpDataConnectorAsync(SetUpDataConnectorRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> SetUpDataConnectorAsync(SetUpDataConnectorRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

UpdateDataConnector(UpdateDataConnectorRequest, CallOptions)

public virtual DataConnector UpdateDataConnector(UpdateDataConnectorRequest request, CallOptions options)

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

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

Returns
Type	Description
DataConnector	The response received from the server.

UpdateDataConnector(UpdateDataConnectorRequest, Metadata, DateTime?, CancellationToken)

public virtual DataConnector UpdateDataConnector(UpdateDataConnectorRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

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

Returns
Type	Description
DataConnector	The response received from the server.

UpdateDataConnectorAsync(UpdateDataConnectorRequest, CallOptions)

public virtual AsyncUnaryCall<DataConnector> UpdateDataConnectorAsync(UpdateDataConnectorRequest request, CallOptions options)

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

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

Returns
Type	Description
AsyncUnaryCallDataConnector	The call object.

UpdateDataConnectorAsync(UpdateDataConnectorRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<DataConnector> UpdateDataConnectorAsync(UpdateDataConnectorRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

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

Returns
Type	Description
AsyncUnaryCallDataConnector	The call object.