Discovery Engine v1 API - Class EngineService.EngineServiceClient (1.0.0-beta02)

public class EngineService.EngineServiceClient : ClientBase<EngineService.EngineServiceClient>

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

Client for EngineService

Inheritance

object > ClientBase > ClientBaseEngineServiceEngineServiceClient > EngineService.EngineServiceClient

Namespace

Google.Cloud.DiscoveryEngine.V1

Assembly

Google.Cloud.DiscoveryEngine.V1.dll

Constructors

EngineServiceClient()

protected EngineServiceClient()

Protected parameterless constructor to allow creation of test doubles.

EngineServiceClient(CallInvoker)

public EngineServiceClient(CallInvoker callInvoker)

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

Parameter
NameDescription
callInvokerCallInvoker

The callInvoker to use to make remote calls.

EngineServiceClient(ChannelBase)

public EngineServiceClient(ChannelBase channel)

Creates a new client for EngineService

Parameter
NameDescription
channelChannelBase

The channel to use to make remote calls.

EngineServiceClient(ClientBaseConfiguration)

protected EngineServiceClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
NameDescription
configurationClientBaseClientBaseConfiguration

The client configuration.

Methods

CreateEngine(CreateEngineRequest, CallOptions)

public virtual Operation CreateEngine(CreateEngineRequest request, CallOptions options)

Creates a [Engine][google.cloud.discoveryengine.v1.Engine].

Parameters
NameDescription
requestCreateEngineRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

CreateEngine(CreateEngineRequest, Metadata, DateTime?, CancellationToken)

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

Creates a [Engine][google.cloud.discoveryengine.v1.Engine].

Parameters
NameDescription
requestCreateEngineRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Operation

The response received from the server.

CreateEngineAsync(CreateEngineRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> CreateEngineAsync(CreateEngineRequest request, CallOptions options)

Creates a [Engine][google.cloud.discoveryengine.v1.Engine].

Parameters
NameDescription
requestCreateEngineRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallOperation

The call object.

CreateEngineAsync(CreateEngineRequest, Metadata, DateTime?, CancellationToken)

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

Creates a [Engine][google.cloud.discoveryengine.v1.Engine].

Parameters
NameDescription
requestCreateEngineRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallOperation

The call object.

CreateLocationsClient()

public virtual Locations.LocationsClient CreateLocationsClient()

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

Returns
TypeDescription
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
TypeDescription
OperationsOperationsClient

A new Operations client for the same target as this client.

DeleteEngine(DeleteEngineRequest, CallOptions)

public virtual Operation DeleteEngine(DeleteEngineRequest request, CallOptions options)

Deletes a [Engine][google.cloud.discoveryengine.v1.Engine].

Parameters
NameDescription
requestDeleteEngineRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

DeleteEngine(DeleteEngineRequest, Metadata, DateTime?, CancellationToken)

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

Deletes a [Engine][google.cloud.discoveryengine.v1.Engine].

Parameters
NameDescription
requestDeleteEngineRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Operation

The response received from the server.

DeleteEngineAsync(DeleteEngineRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> DeleteEngineAsync(DeleteEngineRequest request, CallOptions options)

Deletes a [Engine][google.cloud.discoveryengine.v1.Engine].

Parameters
NameDescription
requestDeleteEngineRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallOperation

The call object.

DeleteEngineAsync(DeleteEngineRequest, Metadata, DateTime?, CancellationToken)

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

Deletes a [Engine][google.cloud.discoveryengine.v1.Engine].

Parameters
NameDescription
requestDeleteEngineRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallOperation

The call object.

GetEngine(GetEngineRequest, CallOptions)

public virtual Engine GetEngine(GetEngineRequest request, CallOptions options)

Gets a [Engine][google.cloud.discoveryengine.v1.Engine].

Parameters
NameDescription
requestGetEngineRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Engine

The response received from the server.

GetEngine(GetEngineRequest, Metadata, DateTime?, CancellationToken)

public virtual Engine GetEngine(GetEngineRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets a [Engine][google.cloud.discoveryengine.v1.Engine].

Parameters
NameDescription
requestGetEngineRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Engine

The response received from the server.

GetEngineAsync(GetEngineRequest, CallOptions)

public virtual AsyncUnaryCall<Engine> GetEngineAsync(GetEngineRequest request, CallOptions options)

Gets a [Engine][google.cloud.discoveryengine.v1.Engine].

Parameters
NameDescription
requestGetEngineRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallEngine

The call object.

GetEngineAsync(GetEngineRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Engine> GetEngineAsync(GetEngineRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets a [Engine][google.cloud.discoveryengine.v1.Engine].

Parameters
NameDescription
requestGetEngineRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallEngine

The call object.

ListEngines(ListEnginesRequest, CallOptions)

public virtual ListEnginesResponse ListEngines(ListEnginesRequest request, CallOptions options)

Lists all the [Engine][google.cloud.discoveryengine.v1.Engine]s associated with the project.

Parameters
NameDescription
requestListEnginesRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
ListEnginesResponse

The response received from the server.

ListEngines(ListEnginesRequest, Metadata, DateTime?, CancellationToken)

public virtual ListEnginesResponse ListEngines(ListEnginesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists all the [Engine][google.cloud.discoveryengine.v1.Engine]s associated with the project.

Parameters
NameDescription
requestListEnginesRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
ListEnginesResponse

The response received from the server.

ListEnginesAsync(ListEnginesRequest, CallOptions)

public virtual AsyncUnaryCall<ListEnginesResponse> ListEnginesAsync(ListEnginesRequest request, CallOptions options)

Lists all the [Engine][google.cloud.discoveryengine.v1.Engine]s associated with the project.

Parameters
NameDescription
requestListEnginesRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallListEnginesResponse

The call object.

ListEnginesAsync(ListEnginesRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ListEnginesResponse> ListEnginesAsync(ListEnginesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists all the [Engine][google.cloud.discoveryengine.v1.Engine]s associated with the project.

Parameters
NameDescription
requestListEnginesRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallListEnginesResponse

The call object.

NewInstance(ClientBaseConfiguration)

protected override EngineService.EngineServiceClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
NameDescription
configurationClientBaseClientBaseConfiguration
Returns
TypeDescription
EngineServiceEngineServiceClient
Overrides

UpdateEngine(UpdateEngineRequest, CallOptions)

public virtual Engine UpdateEngine(UpdateEngineRequest request, CallOptions options)

Updates an [Engine][google.cloud.discoveryengine.v1.Engine]

Parameters
NameDescription
requestUpdateEngineRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Engine

The response received from the server.

UpdateEngine(UpdateEngineRequest, Metadata, DateTime?, CancellationToken)

public virtual Engine UpdateEngine(UpdateEngineRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Updates an [Engine][google.cloud.discoveryengine.v1.Engine]

Parameters
NameDescription
requestUpdateEngineRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Engine

The response received from the server.

UpdateEngineAsync(UpdateEngineRequest, CallOptions)

public virtual AsyncUnaryCall<Engine> UpdateEngineAsync(UpdateEngineRequest request, CallOptions options)

Updates an [Engine][google.cloud.discoveryengine.v1.Engine]

Parameters
NameDescription
requestUpdateEngineRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallEngine

The call object.

UpdateEngineAsync(UpdateEngineRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Engine> UpdateEngineAsync(UpdateEngineRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Updates an [Engine][google.cloud.discoveryengine.v1.Engine]

Parameters
NameDescription
requestUpdateEngineRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallEngine

The call object.