Discovery Engine v1beta API - Class SampleQueryService.SampleQueryServiceClient (1.0.0-beta16)

Version 1.0.0-beta16

• 1.0.0-beta18 (latest)
• 1.0.0-beta17

public class SampleQueryService.SampleQueryServiceClient : ClientBase<SampleQueryService.SampleQueryServiceClient>

Reference documentation and code samples for the Discovery Engine v1beta API class SampleQueryService.SampleQueryServiceClient.

Client for SampleQueryService

Inheritance

object > ClientBase > ClientBaseSampleQueryServiceSampleQueryServiceClient > SampleQueryService.SampleQueryServiceClient

Inherited Members

ClientBase<SampleQueryService.SampleQueryServiceClient>.WithHost(string)

ClientBase.CallInvoker

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

Namespace

Google.Cloud.DiscoveryEngine.V1Beta

Assembly

Google.Cloud.DiscoveryEngine.V1Beta.dll

Constructors

SampleQueryServiceClient()

protected SampleQueryServiceClient()

Protected parameterless constructor to allow creation of test doubles.

SampleQueryServiceClient(CallInvoker)

public SampleQueryServiceClient(CallInvoker callInvoker)

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

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

SampleQueryServiceClient(ChannelBase)

public SampleQueryServiceClient(ChannelBase channel)

Creates a new client for SampleQueryService

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

SampleQueryServiceClient(ClientBaseConfiguration)

protected SampleQueryServiceClient(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.

CreateSampleQuery(CreateSampleQueryRequest, CallOptions)

public virtual SampleQuery CreateSampleQuery(CreateSampleQueryRequest request, CallOptions options)

Creates a [SampleQuery][google.cloud.discoveryengine.v1beta.SampleQuery]

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

Returns
Type	Description
SampleQuery	The response received from the server.

CreateSampleQuery(CreateSampleQueryRequest, Metadata, DateTime?, CancellationToken)

public virtual SampleQuery CreateSampleQuery(CreateSampleQueryRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Creates a [SampleQuery][google.cloud.discoveryengine.v1beta.SampleQuery]

Parameters
Name	Description
request	CreateSampleQueryRequest 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
SampleQuery	The response received from the server.

CreateSampleQueryAsync(CreateSampleQueryRequest, CallOptions)

public virtual AsyncUnaryCall<SampleQuery> CreateSampleQueryAsync(CreateSampleQueryRequest request, CallOptions options)

Creates a [SampleQuery][google.cloud.discoveryengine.v1beta.SampleQuery]

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

Returns
Type	Description
AsyncUnaryCallSampleQuery	The call object.

CreateSampleQueryAsync(CreateSampleQueryRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<SampleQuery> CreateSampleQueryAsync(CreateSampleQueryRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Creates a [SampleQuery][google.cloud.discoveryengine.v1beta.SampleQuery]

Parameters
Name	Description
request	CreateSampleQueryRequest 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
AsyncUnaryCallSampleQuery	The call object.

DeleteSampleQuery(DeleteSampleQueryRequest, CallOptions)

public virtual Empty DeleteSampleQuery(DeleteSampleQueryRequest request, CallOptions options)

Deletes a [SampleQuery][google.cloud.discoveryengine.v1beta.SampleQuery].

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

Returns
Type	Description
Empty	The response received from the server.

DeleteSampleQuery(DeleteSampleQueryRequest, Metadata, DateTime?, CancellationToken)

public virtual Empty DeleteSampleQuery(DeleteSampleQueryRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Deletes a [SampleQuery][google.cloud.discoveryengine.v1beta.SampleQuery].

Parameters
Name	Description
request	DeleteSampleQueryRequest 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
Empty	The response received from the server.

DeleteSampleQueryAsync(DeleteSampleQueryRequest, CallOptions)

public virtual AsyncUnaryCall<Empty> DeleteSampleQueryAsync(DeleteSampleQueryRequest request, CallOptions options)

Deletes a [SampleQuery][google.cloud.discoveryengine.v1beta.SampleQuery].

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

Returns
Type	Description
AsyncUnaryCallEmpty	The call object.

DeleteSampleQueryAsync(DeleteSampleQueryRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Empty> DeleteSampleQueryAsync(DeleteSampleQueryRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Deletes a [SampleQuery][google.cloud.discoveryengine.v1beta.SampleQuery].

Parameters
Name	Description
request	DeleteSampleQueryRequest 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
AsyncUnaryCallEmpty	The call object.

GetSampleQuery(GetSampleQueryRequest, CallOptions)

public virtual SampleQuery GetSampleQuery(GetSampleQueryRequest request, CallOptions options)

Gets a [SampleQuery][google.cloud.discoveryengine.v1beta.SampleQuery].

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

Returns
Type	Description
SampleQuery	The response received from the server.

GetSampleQuery(GetSampleQueryRequest, Metadata, DateTime?, CancellationToken)

public virtual SampleQuery GetSampleQuery(GetSampleQueryRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets a [SampleQuery][google.cloud.discoveryengine.v1beta.SampleQuery].

Parameters
Name	Description
request	GetSampleQueryRequest 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
SampleQuery	The response received from the server.

GetSampleQueryAsync(GetSampleQueryRequest, CallOptions)

public virtual AsyncUnaryCall<SampleQuery> GetSampleQueryAsync(GetSampleQueryRequest request, CallOptions options)

Gets a [SampleQuery][google.cloud.discoveryengine.v1beta.SampleQuery].

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

Returns
Type	Description
AsyncUnaryCallSampleQuery	The call object.

GetSampleQueryAsync(GetSampleQueryRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<SampleQuery> GetSampleQueryAsync(GetSampleQueryRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets a [SampleQuery][google.cloud.discoveryengine.v1beta.SampleQuery].

Parameters
Name	Description
request	GetSampleQueryRequest 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
AsyncUnaryCallSampleQuery	The call object.

ImportSampleQueries(ImportSampleQueriesRequest, CallOptions)

public virtual Operation ImportSampleQueries(ImportSampleQueriesRequest request, CallOptions options)

Bulk import of multiple [SampleQuery][google.cloud.discoveryengine.v1beta.SampleQuery]s. Sample queries that already exist may be deleted.

Note: It is possible for a subset of the [SampleQuery][google.cloud.discoveryengine.v1beta.SampleQuery]s to be successfully imported.

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

Returns
Type	Description
Operation	The response received from the server.

ImportSampleQueries(ImportSampleQueriesRequest, Metadata, DateTime?, CancellationToken)

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

Bulk import of multiple [SampleQuery][google.cloud.discoveryengine.v1beta.SampleQuery]s. Sample queries that already exist may be deleted.

Note: It is possible for a subset of the [SampleQuery][google.cloud.discoveryengine.v1beta.SampleQuery]s to be successfully imported.

Parameters
Name	Description
request	ImportSampleQueriesRequest 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.

ImportSampleQueriesAsync(ImportSampleQueriesRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> ImportSampleQueriesAsync(ImportSampleQueriesRequest request, CallOptions options)

Bulk import of multiple [SampleQuery][google.cloud.discoveryengine.v1beta.SampleQuery]s. Sample queries that already exist may be deleted.

Note: It is possible for a subset of the [SampleQuery][google.cloud.discoveryengine.v1beta.SampleQuery]s to be successfully imported.

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

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

ImportSampleQueriesAsync(ImportSampleQueriesRequest, Metadata, DateTime?, CancellationToken)

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

Bulk import of multiple [SampleQuery][google.cloud.discoveryengine.v1beta.SampleQuery]s. Sample queries that already exist may be deleted.

Note: It is possible for a subset of the [SampleQuery][google.cloud.discoveryengine.v1beta.SampleQuery]s to be successfully imported.

Parameters
Name	Description
request	ImportSampleQueriesRequest 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.

ListSampleQueries(ListSampleQueriesRequest, CallOptions)

public virtual ListSampleQueriesResponse ListSampleQueries(ListSampleQueriesRequest request, CallOptions options)

Gets a list of [SampleQuery][google.cloud.discoveryengine.v1beta.SampleQuery]s.

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

Returns
Type	Description
ListSampleQueriesResponse	The response received from the server.

ListSampleQueries(ListSampleQueriesRequest, Metadata, DateTime?, CancellationToken)

public virtual ListSampleQueriesResponse ListSampleQueries(ListSampleQueriesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets a list of [SampleQuery][google.cloud.discoveryengine.v1beta.SampleQuery]s.

Parameters
Name	Description
request	ListSampleQueriesRequest 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
ListSampleQueriesResponse	The response received from the server.

ListSampleQueriesAsync(ListSampleQueriesRequest, CallOptions)

public virtual AsyncUnaryCall<ListSampleQueriesResponse> ListSampleQueriesAsync(ListSampleQueriesRequest request, CallOptions options)

Gets a list of [SampleQuery][google.cloud.discoveryengine.v1beta.SampleQuery]s.

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

Returns
Type	Description
AsyncUnaryCallListSampleQueriesResponse	The call object.

ListSampleQueriesAsync(ListSampleQueriesRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ListSampleQueriesResponse> ListSampleQueriesAsync(ListSampleQueriesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets a list of [SampleQuery][google.cloud.discoveryengine.v1beta.SampleQuery]s.

Parameters
Name	Description
request	ListSampleQueriesRequest 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
AsyncUnaryCallListSampleQueriesResponse	The call object.

NewInstance(ClientBaseConfiguration)

protected override SampleQueryService.SampleQueryServiceClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
Name	Description
configuration	ClientBaseClientBaseConfiguration

Returns
Type	Description
SampleQueryServiceSampleQueryServiceClient

Overrides

Grpc.Core.ClientBase<Google.Cloud.DiscoveryEngine.V1Beta.SampleQueryService.SampleQueryServiceClient>.NewInstance(Grpc.Core.ClientBase.ClientBaseConfiguration)

UpdateSampleQuery(UpdateSampleQueryRequest, CallOptions)

public virtual SampleQuery UpdateSampleQuery(UpdateSampleQueryRequest request, CallOptions options)

Updates a [SampleQuery][google.cloud.discoveryengine.v1beta.SampleQuery].

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

Returns
Type	Description
SampleQuery	The response received from the server.

UpdateSampleQuery(UpdateSampleQueryRequest, Metadata, DateTime?, CancellationToken)

public virtual SampleQuery UpdateSampleQuery(UpdateSampleQueryRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Updates a [SampleQuery][google.cloud.discoveryengine.v1beta.SampleQuery].

Parameters
Name	Description
request	UpdateSampleQueryRequest 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
SampleQuery	The response received from the server.

UpdateSampleQueryAsync(UpdateSampleQueryRequest, CallOptions)

public virtual AsyncUnaryCall<SampleQuery> UpdateSampleQueryAsync(UpdateSampleQueryRequest request, CallOptions options)

Updates a [SampleQuery][google.cloud.discoveryengine.v1beta.SampleQuery].

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

Returns
Type	Description
AsyncUnaryCallSampleQuery	The call object.

UpdateSampleQueryAsync(UpdateSampleQueryRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<SampleQuery> UpdateSampleQueryAsync(UpdateSampleQueryRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Updates a [SampleQuery][google.cloud.discoveryengine.v1beta.SampleQuery].

Parameters
Name	Description
request	UpdateSampleQueryRequest 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
AsyncUnaryCallSampleQuery	The call object.