Class protos.google.cloud.discoveryengine.v1alpha.SampleQueryService (2.6.0)

Represents a SampleQueryService

Inheritance

$protobuf.rpc.Service > protos.google.cloud.discoveryengine.v1alpha.SampleQueryService

Package

@google-cloud/discoveryengine

Constructors

(constructor)(rpcImpl, requestDelimited, responseDelimited)

constructor(rpcImpl: $protobuf.RPCImpl, requestDelimited?: boolean, responseDelimited?: boolean);

Constructs a new SampleQueryService service.

Parameters
Name Description
rpcImpl $protobuf.RPCImpl

RPC implementation
requestDelimited boolean

Whether requests are length-delimited
responseDelimited boolean

Whether responses are length-delimited

Methods

create(rpcImpl, requestDelimited, responseDelimited)

public static create(rpcImpl: $protobuf.RPCImpl, requestDelimited?: boolean, responseDelimited?: boolean): SampleQueryService;

Creates new SampleQueryService service using the specified rpc implementation.

Parameters
Name Description
rpcImpl $protobuf.RPCImpl

RPC implementation
requestDelimited boolean

Whether requests are length-delimited
responseDelimited boolean

Whether responses are length-delimited
Returns
Type Description
SampleQueryService

RPC service. Useful where requests and/or responses are streamed.

createSampleQuery(request, callback)

public createSampleQuery(request: google.cloud.discoveryengine.v1alpha.ICreateSampleQueryRequest, callback: google.cloud.discoveryengine.v1alpha.SampleQueryService.CreateSampleQueryCallback): void;

Calls CreateSampleQuery.

Parameters
Name Description
request ICreateSampleQueryRequest

CreateSampleQueryRequest message or plain object
callback CreateSampleQueryCallback

Node-style callback called with the error, if any, and SampleQuery
Returns
Type Description
void

createSampleQuery(request)

public createSampleQuery(request: google.cloud.discoveryengine.v1alpha.ICreateSampleQueryRequest): Promise<google.cloud.discoveryengine.v1alpha.SampleQuery>;

Calls CreateSampleQuery.

Parameter
Name Description
request ICreateSampleQueryRequest

CreateSampleQueryRequest message or plain object
Returns
Type Description
Promise<google.cloud.discoveryengine.v1alpha.SampleQuery>

Promise

deleteSampleQuery(request, callback)

public deleteSampleQuery(request: google.cloud.discoveryengine.v1alpha.IDeleteSampleQueryRequest, callback: google.cloud.discoveryengine.v1alpha.SampleQueryService.DeleteSampleQueryCallback): void;

Calls DeleteSampleQuery.

Parameters
Name Description
request IDeleteSampleQueryRequest

DeleteSampleQueryRequest message or plain object
callback DeleteSampleQueryCallback

Node-style callback called with the error, if any, and Empty
Returns
Type Description
void

deleteSampleQuery(request)

public deleteSampleQuery(request: google.cloud.discoveryengine.v1alpha.IDeleteSampleQueryRequest): Promise<google.protobuf.Empty>;

Calls DeleteSampleQuery.

Parameter
Name Description
request IDeleteSampleQueryRequest

DeleteSampleQueryRequest message or plain object
Returns
Type Description
Promise<google.protobuf.Empty>

Promise

getSampleQuery(request, callback)

public getSampleQuery(request: google.cloud.discoveryengine.v1alpha.IGetSampleQueryRequest, callback: google.cloud.discoveryengine.v1alpha.SampleQueryService.GetSampleQueryCallback): void;

Calls GetSampleQuery.

Parameters
Name Description
request IGetSampleQueryRequest

GetSampleQueryRequest message or plain object
callback GetSampleQueryCallback

Node-style callback called with the error, if any, and SampleQuery
Returns
Type Description
void

getSampleQuery(request)

public getSampleQuery(request: google.cloud.discoveryengine.v1alpha.IGetSampleQueryRequest): Promise<google.cloud.discoveryengine.v1alpha.SampleQuery>;

Calls GetSampleQuery.

Parameter
Name Description
request IGetSampleQueryRequest

GetSampleQueryRequest message or plain object
Returns
Type Description
Promise<google.cloud.discoveryengine.v1alpha.SampleQuery>

Promise

importSampleQueries(request, callback)

public importSampleQueries(request: google.cloud.discoveryengine.v1alpha.IImportSampleQueriesRequest, callback: google.cloud.discoveryengine.v1alpha.SampleQueryService.ImportSampleQueriesCallback): void;

Calls ImportSampleQueries.

Parameters
Name Description
request IImportSampleQueriesRequest

ImportSampleQueriesRequest message or plain object
callback ImportSampleQueriesCallback

Node-style callback called with the error, if any, and Operation
Returns
Type Description
void

importSampleQueries(request)

public importSampleQueries(request: google.cloud.discoveryengine.v1alpha.IImportSampleQueriesRequest): Promise<google.longrunning.Operation>;

Calls ImportSampleQueries.

Parameter
Name Description
request IImportSampleQueriesRequest

ImportSampleQueriesRequest message or plain object
Returns
Type Description
Promise<google.longrunning.Operation>

Promise

listSampleQueries(request, callback)

public listSampleQueries(request: google.cloud.discoveryengine.v1alpha.IListSampleQueriesRequest, callback: google.cloud.discoveryengine.v1alpha.SampleQueryService.ListSampleQueriesCallback): void;

Calls ListSampleQueries.

Parameters
Name Description
request IListSampleQueriesRequest

ListSampleQueriesRequest message or plain object
callback ListSampleQueriesCallback

Node-style callback called with the error, if any, and ListSampleQueriesResponse
Returns
Type Description
void

listSampleQueries(request)

public listSampleQueries(request: google.cloud.discoveryengine.v1alpha.IListSampleQueriesRequest): Promise<google.cloud.discoveryengine.v1alpha.ListSampleQueriesResponse>;

Calls ListSampleQueries.

Parameter
Name Description
request IListSampleQueriesRequest

ListSampleQueriesRequest message or plain object
Returns
Type Description
Promise<google.cloud.discoveryengine.v1alpha.ListSampleQueriesResponse>

Promise

updateSampleQuery(request, callback)

public updateSampleQuery(request: google.cloud.discoveryengine.v1alpha.IUpdateSampleQueryRequest, callback: google.cloud.discoveryengine.v1alpha.SampleQueryService.UpdateSampleQueryCallback): void;

Calls UpdateSampleQuery.

Parameters
Name Description
request IUpdateSampleQueryRequest

UpdateSampleQueryRequest message or plain object
callback UpdateSampleQueryCallback

Node-style callback called with the error, if any, and SampleQuery
Returns
Type Description
void

updateSampleQuery(request)

public updateSampleQuery(request: google.cloud.discoveryengine.v1alpha.IUpdateSampleQueryRequest): Promise<google.cloud.discoveryengine.v1alpha.SampleQuery>;

Calls UpdateSampleQuery.

Parameter
Name Description
request IUpdateSampleQueryRequest

UpdateSampleQueryRequest message or plain object
Returns
Type Description
Promise<google.cloud.discoveryengine.v1alpha.SampleQuery>

Promise