Class protos.google.cloud.aiplatform.v1.DatasetService (3.13.0)

Represents a DatasetService

Inheritance

$protobuf.rpc.Service > protos.google.cloud.aiplatform.v1.DatasetService

Package

@google-cloud/aiplatform

Constructors

(constructor)(rpcImpl, requestDelimited, responseDelimited)

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

Constructs a new DatasetService service.

Parameters
NameDescription
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): DatasetService;

Creates new DatasetService service using the specified rpc implementation.

Parameters
NameDescription
rpcImpl $protobuf.RPCImpl

RPC implementation

requestDelimited boolean

Whether requests are length-delimited

responseDelimited boolean

Whether responses are length-delimited

Returns
TypeDescription
DatasetService

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

createDataset(request, callback)

public createDataset(request: google.cloud.aiplatform.v1.ICreateDatasetRequest, callback: google.cloud.aiplatform.v1.DatasetService.CreateDatasetCallback): void;

Calls CreateDataset.

Parameters
NameDescription
request ICreateDatasetRequest

CreateDatasetRequest message or plain object

callback CreateDatasetCallback

Node-style callback called with the error, if any, and Operation

Returns
TypeDescription
void

createDataset(request)

public createDataset(request: google.cloud.aiplatform.v1.ICreateDatasetRequest): Promise<google.longrunning.Operation>;

Calls CreateDataset.

Parameter
NameDescription
request ICreateDatasetRequest

CreateDatasetRequest message or plain object

Returns
TypeDescription
Promise<google.longrunning.Operation>

Promise

createDatasetVersion(request, callback)

public createDatasetVersion(request: google.cloud.aiplatform.v1.ICreateDatasetVersionRequest, callback: google.cloud.aiplatform.v1.DatasetService.CreateDatasetVersionCallback): void;

Calls CreateDatasetVersion.

Parameters
NameDescription
request ICreateDatasetVersionRequest

CreateDatasetVersionRequest message or plain object

callback CreateDatasetVersionCallback

Node-style callback called with the error, if any, and Operation

Returns
TypeDescription
void

createDatasetVersion(request)

public createDatasetVersion(request: google.cloud.aiplatform.v1.ICreateDatasetVersionRequest): Promise<google.longrunning.Operation>;

Calls CreateDatasetVersion.

Parameter
NameDescription
request ICreateDatasetVersionRequest

CreateDatasetVersionRequest message or plain object

Returns
TypeDescription
Promise<google.longrunning.Operation>

Promise

deleteDataset(request, callback)

public deleteDataset(request: google.cloud.aiplatform.v1.IDeleteDatasetRequest, callback: google.cloud.aiplatform.v1.DatasetService.DeleteDatasetCallback): void;

Calls DeleteDataset.

Parameters
NameDescription
request IDeleteDatasetRequest

DeleteDatasetRequest message or plain object

callback DeleteDatasetCallback

Node-style callback called with the error, if any, and Operation

Returns
TypeDescription
void

deleteDataset(request)

public deleteDataset(request: google.cloud.aiplatform.v1.IDeleteDatasetRequest): Promise<google.longrunning.Operation>;

Calls DeleteDataset.

Parameter
NameDescription
request IDeleteDatasetRequest

DeleteDatasetRequest message or plain object

Returns
TypeDescription
Promise<google.longrunning.Operation>

Promise

deleteDatasetVersion(request, callback)

public deleteDatasetVersion(request: google.cloud.aiplatform.v1.IDeleteDatasetVersionRequest, callback: google.cloud.aiplatform.v1.DatasetService.DeleteDatasetVersionCallback): void;

Calls DeleteDatasetVersion.

Parameters
NameDescription
request IDeleteDatasetVersionRequest

DeleteDatasetVersionRequest message or plain object

callback DeleteDatasetVersionCallback

Node-style callback called with the error, if any, and Operation

Returns
TypeDescription
void

deleteDatasetVersion(request)

public deleteDatasetVersion(request: google.cloud.aiplatform.v1.IDeleteDatasetVersionRequest): Promise<google.longrunning.Operation>;

Calls DeleteDatasetVersion.

Parameter
NameDescription
request IDeleteDatasetVersionRequest

DeleteDatasetVersionRequest message or plain object

Returns
TypeDescription
Promise<google.longrunning.Operation>

Promise

deleteSavedQuery(request, callback)

public deleteSavedQuery(request: google.cloud.aiplatform.v1.IDeleteSavedQueryRequest, callback: google.cloud.aiplatform.v1.DatasetService.DeleteSavedQueryCallback): void;

Calls DeleteSavedQuery.

Parameters
NameDescription
request IDeleteSavedQueryRequest

DeleteSavedQueryRequest message or plain object

callback DeleteSavedQueryCallback

Node-style callback called with the error, if any, and Operation

Returns
TypeDescription
void

deleteSavedQuery(request)

public deleteSavedQuery(request: google.cloud.aiplatform.v1.IDeleteSavedQueryRequest): Promise<google.longrunning.Operation>;

Calls DeleteSavedQuery.

Parameter
NameDescription
request IDeleteSavedQueryRequest

DeleteSavedQueryRequest message or plain object

Returns
TypeDescription
Promise<google.longrunning.Operation>

Promise

exportData(request, callback)

public exportData(request: google.cloud.aiplatform.v1.IExportDataRequest, callback: google.cloud.aiplatform.v1.DatasetService.ExportDataCallback): void;

Calls ExportData.

Parameters
NameDescription
request IExportDataRequest

ExportDataRequest message or plain object

callback ExportDataCallback

Node-style callback called with the error, if any, and Operation

Returns
TypeDescription
void

exportData(request)

public exportData(request: google.cloud.aiplatform.v1.IExportDataRequest): Promise<google.longrunning.Operation>;

Calls ExportData.

Parameter
NameDescription
request IExportDataRequest

ExportDataRequest message or plain object

Returns
TypeDescription
Promise<google.longrunning.Operation>

Promise

getAnnotationSpec(request, callback)

public getAnnotationSpec(request: google.cloud.aiplatform.v1.IGetAnnotationSpecRequest, callback: google.cloud.aiplatform.v1.DatasetService.GetAnnotationSpecCallback): void;

Calls GetAnnotationSpec.

Parameters
NameDescription
request IGetAnnotationSpecRequest

GetAnnotationSpecRequest message or plain object

callback GetAnnotationSpecCallback

Node-style callback called with the error, if any, and AnnotationSpec

Returns
TypeDescription
void

getAnnotationSpec(request)

public getAnnotationSpec(request: google.cloud.aiplatform.v1.IGetAnnotationSpecRequest): Promise<google.cloud.aiplatform.v1.AnnotationSpec>;

Calls GetAnnotationSpec.

Parameter
NameDescription
request IGetAnnotationSpecRequest

GetAnnotationSpecRequest message or plain object

Returns
TypeDescription
Promise<google.cloud.aiplatform.v1.AnnotationSpec>

Promise

getDataset(request, callback)

public getDataset(request: google.cloud.aiplatform.v1.IGetDatasetRequest, callback: google.cloud.aiplatform.v1.DatasetService.GetDatasetCallback): void;

Calls GetDataset.

Parameters
NameDescription
request IGetDatasetRequest

GetDatasetRequest message or plain object

callback GetDatasetCallback

Node-style callback called with the error, if any, and Dataset

Returns
TypeDescription
void

getDataset(request)

public getDataset(request: google.cloud.aiplatform.v1.IGetDatasetRequest): Promise<google.cloud.aiplatform.v1.Dataset>;

Calls GetDataset.

Parameter
NameDescription
request IGetDatasetRequest

GetDatasetRequest message or plain object

Returns
TypeDescription
Promise<google.cloud.aiplatform.v1.Dataset>

Promise

getDatasetVersion(request, callback)

public getDatasetVersion(request: google.cloud.aiplatform.v1.IGetDatasetVersionRequest, callback: google.cloud.aiplatform.v1.DatasetService.GetDatasetVersionCallback): void;

Calls GetDatasetVersion.

Parameters
NameDescription
request IGetDatasetVersionRequest

GetDatasetVersionRequest message or plain object

callback GetDatasetVersionCallback

Node-style callback called with the error, if any, and DatasetVersion

Returns
TypeDescription
void

getDatasetVersion(request)

public getDatasetVersion(request: google.cloud.aiplatform.v1.IGetDatasetVersionRequest): Promise<google.cloud.aiplatform.v1.DatasetVersion>;

Calls GetDatasetVersion.

Parameter
NameDescription
request IGetDatasetVersionRequest

GetDatasetVersionRequest message or plain object

Returns
TypeDescription
Promise<google.cloud.aiplatform.v1.DatasetVersion>

Promise

importData(request, callback)

public importData(request: google.cloud.aiplatform.v1.IImportDataRequest, callback: google.cloud.aiplatform.v1.DatasetService.ImportDataCallback): void;

Calls ImportData.

Parameters
NameDescription
request IImportDataRequest

ImportDataRequest message or plain object

callback ImportDataCallback

Node-style callback called with the error, if any, and Operation

Returns
TypeDescription
void

importData(request)

public importData(request: google.cloud.aiplatform.v1.IImportDataRequest): Promise<google.longrunning.Operation>;

Calls ImportData.

Parameter
NameDescription
request IImportDataRequest

ImportDataRequest message or plain object

Returns
TypeDescription
Promise<google.longrunning.Operation>

Promise

listAnnotations(request, callback)

public listAnnotations(request: google.cloud.aiplatform.v1.IListAnnotationsRequest, callback: google.cloud.aiplatform.v1.DatasetService.ListAnnotationsCallback): void;

Calls ListAnnotations.

Parameters
NameDescription
request IListAnnotationsRequest

ListAnnotationsRequest message or plain object

callback ListAnnotationsCallback

Node-style callback called with the error, if any, and ListAnnotationsResponse

Returns
TypeDescription
void

listAnnotations(request)

public listAnnotations(request: google.cloud.aiplatform.v1.IListAnnotationsRequest): Promise<google.cloud.aiplatform.v1.ListAnnotationsResponse>;

Calls ListAnnotations.

Parameter
NameDescription
request IListAnnotationsRequest

ListAnnotationsRequest message or plain object

Returns
TypeDescription
Promise<google.cloud.aiplatform.v1.ListAnnotationsResponse>

Promise

listDataItems(request, callback)

public listDataItems(request: google.cloud.aiplatform.v1.IListDataItemsRequest, callback: google.cloud.aiplatform.v1.DatasetService.ListDataItemsCallback): void;

Calls ListDataItems.

Parameters
NameDescription
request IListDataItemsRequest

ListDataItemsRequest message or plain object

callback ListDataItemsCallback

Node-style callback called with the error, if any, and ListDataItemsResponse

Returns
TypeDescription
void

listDataItems(request)

public listDataItems(request: google.cloud.aiplatform.v1.IListDataItemsRequest): Promise<google.cloud.aiplatform.v1.ListDataItemsResponse>;

Calls ListDataItems.

Parameter
NameDescription
request IListDataItemsRequest

ListDataItemsRequest message or plain object

Returns
TypeDescription
Promise<google.cloud.aiplatform.v1.ListDataItemsResponse>

Promise

listDatasets(request, callback)

public listDatasets(request: google.cloud.aiplatform.v1.IListDatasetsRequest, callback: google.cloud.aiplatform.v1.DatasetService.ListDatasetsCallback): void;

Calls ListDatasets.

Parameters
NameDescription
request IListDatasetsRequest

ListDatasetsRequest message or plain object

callback ListDatasetsCallback

Node-style callback called with the error, if any, and ListDatasetsResponse

Returns
TypeDescription
void

listDatasets(request)

public listDatasets(request: google.cloud.aiplatform.v1.IListDatasetsRequest): Promise<google.cloud.aiplatform.v1.ListDatasetsResponse>;

Calls ListDatasets.

Parameter
NameDescription
request IListDatasetsRequest

ListDatasetsRequest message or plain object

Returns
TypeDescription
Promise<google.cloud.aiplatform.v1.ListDatasetsResponse>

Promise

listDatasetVersions(request, callback)

public listDatasetVersions(request: google.cloud.aiplatform.v1.IListDatasetVersionsRequest, callback: google.cloud.aiplatform.v1.DatasetService.ListDatasetVersionsCallback): void;

Calls ListDatasetVersions.

Parameters
NameDescription
request IListDatasetVersionsRequest

ListDatasetVersionsRequest message or plain object

callback ListDatasetVersionsCallback

Node-style callback called with the error, if any, and ListDatasetVersionsResponse

Returns
TypeDescription
void

listDatasetVersions(request)

public listDatasetVersions(request: google.cloud.aiplatform.v1.IListDatasetVersionsRequest): Promise<google.cloud.aiplatform.v1.ListDatasetVersionsResponse>;

Calls ListDatasetVersions.

Parameter
NameDescription
request IListDatasetVersionsRequest

ListDatasetVersionsRequest message or plain object

Returns
TypeDescription
Promise<google.cloud.aiplatform.v1.ListDatasetVersionsResponse>

Promise

listSavedQueries(request, callback)

public listSavedQueries(request: google.cloud.aiplatform.v1.IListSavedQueriesRequest, callback: google.cloud.aiplatform.v1.DatasetService.ListSavedQueriesCallback): void;

Calls ListSavedQueries.

Parameters
NameDescription
request IListSavedQueriesRequest

ListSavedQueriesRequest message or plain object

callback ListSavedQueriesCallback

Node-style callback called with the error, if any, and ListSavedQueriesResponse

Returns
TypeDescription
void

listSavedQueries(request)

public listSavedQueries(request: google.cloud.aiplatform.v1.IListSavedQueriesRequest): Promise<google.cloud.aiplatform.v1.ListSavedQueriesResponse>;

Calls ListSavedQueries.

Parameter
NameDescription
request IListSavedQueriesRequest

ListSavedQueriesRequest message or plain object

Returns
TypeDescription
Promise<google.cloud.aiplatform.v1.ListSavedQueriesResponse>

Promise

restoreDatasetVersion(request, callback)

public restoreDatasetVersion(request: google.cloud.aiplatform.v1.IRestoreDatasetVersionRequest, callback: google.cloud.aiplatform.v1.DatasetService.RestoreDatasetVersionCallback): void;

Calls RestoreDatasetVersion.

Parameters
NameDescription
request IRestoreDatasetVersionRequest

RestoreDatasetVersionRequest message or plain object

callback RestoreDatasetVersionCallback

Node-style callback called with the error, if any, and Operation

Returns
TypeDescription
void

restoreDatasetVersion(request)

public restoreDatasetVersion(request: google.cloud.aiplatform.v1.IRestoreDatasetVersionRequest): Promise<google.longrunning.Operation>;

Calls RestoreDatasetVersion.

Parameter
NameDescription
request IRestoreDatasetVersionRequest

RestoreDatasetVersionRequest message or plain object

Returns
TypeDescription
Promise<google.longrunning.Operation>

Promise

searchDataItems(request, callback)

public searchDataItems(request: google.cloud.aiplatform.v1.ISearchDataItemsRequest, callback: google.cloud.aiplatform.v1.DatasetService.SearchDataItemsCallback): void;

Calls SearchDataItems.

Parameters
NameDescription
request ISearchDataItemsRequest

SearchDataItemsRequest message or plain object

callback SearchDataItemsCallback

Node-style callback called with the error, if any, and SearchDataItemsResponse

Returns
TypeDescription
void

searchDataItems(request)

public searchDataItems(request: google.cloud.aiplatform.v1.ISearchDataItemsRequest): Promise<google.cloud.aiplatform.v1.SearchDataItemsResponse>;

Calls SearchDataItems.

Parameter
NameDescription
request ISearchDataItemsRequest

SearchDataItemsRequest message or plain object

Returns
TypeDescription
Promise<google.cloud.aiplatform.v1.SearchDataItemsResponse>

Promise

updateDataset(request, callback)

public updateDataset(request: google.cloud.aiplatform.v1.IUpdateDatasetRequest, callback: google.cloud.aiplatform.v1.DatasetService.UpdateDatasetCallback): void;

Calls UpdateDataset.

Parameters
NameDescription
request IUpdateDatasetRequest

UpdateDatasetRequest message or plain object

callback UpdateDatasetCallback

Node-style callback called with the error, if any, and Dataset

Returns
TypeDescription
void

updateDataset(request)

public updateDataset(request: google.cloud.aiplatform.v1.IUpdateDatasetRequest): Promise<google.cloud.aiplatform.v1.Dataset>;

Calls UpdateDataset.

Parameter
NameDescription
request IUpdateDatasetRequest

UpdateDatasetRequest message or plain object

Returns
TypeDescription
Promise<google.cloud.aiplatform.v1.Dataset>

Promise