Class v1beta1.DatasetServiceClient (1.7.2)

v1beta1

Package

@google-cloud/aiplatform!

Constructors

(constructor)(opts)

constructor(opts?: ClientOptions);

Construct an instance of DatasetServiceClient.

Parameter
NameDescription
opts ClientOptions

Properties

apiEndpoint

static get apiEndpoint(): string;

The DNS address for this API service - same as servicePath(), exists for compatibility reasons.

Property Value
TypeDescription
string

auth

auth: gax.GoogleAuth;
Property Value
TypeDescription
gax.GoogleAuth

datasetServiceStub

datasetServiceStub?: Promise<{
        [name: string]: Function;
    }>;
Property Value
TypeDescription
Promise<{ [name: string]: Function; }>

descriptors

descriptors: Descriptors;
Property Value
TypeDescription
Descriptors

innerApiCalls

innerApiCalls: {
        [name: string]: Function;
    };
Property Value
TypeDescription
{ [name: string]: Function; }

operationsClient

operationsClient: gax.OperationsClient;
Property Value
TypeDescription
gax.OperationsClient

pathTemplates

pathTemplates: {
        [name: string]: gax.PathTemplate;
    };
Property Value
TypeDescription
{ [name: string]: gax.PathTemplate; }

port

static get port(): number;

The port for this API service.

Property Value
TypeDescription
number

scopes

static get scopes(): string[];

The scopes needed to make gRPC calls for every method defined in this service.

Property Value
TypeDescription
string[]

servicePath

static get servicePath(): string;

The DNS address for this API service.

Property Value
TypeDescription
string

Methods

annotationPath(project, location, dataset, dataItem, annotation)

annotationPath(project: string, location: string, dataset: string, dataItem: string, annotation: string): string;

Return a fully-qualified annotation resource name string.

Parameters
NameDescription
project string
location string
dataset string
dataItem string
annotation string
Returns
TypeDescription
string

{string} Resource name string.

annotationSpecPath(project, location, dataset, annotationSpec)

annotationSpecPath(project: string, location: string, dataset: string, annotationSpec: string): string;

Return a fully-qualified annotationSpec resource name string.

Parameters
NameDescription
project string
location string
dataset string
annotationSpec string
Returns
TypeDescription
string

{string} Resource name string.

artifactPath(project, location, metadataStore, artifact)

artifactPath(project: string, location: string, metadataStore: string, artifact: string): string;

Return a fully-qualified artifact resource name string.

Parameters
NameDescription
project string
location string
metadataStore string
artifact string
Returns
TypeDescription
string

{string} Resource name string.

batchPredictionJobPath(project, location, batchPredictionJob)

batchPredictionJobPath(project: string, location: string, batchPredictionJob: string): string;

Return a fully-qualified batchPredictionJob resource name string.

Parameters
NameDescription
project string
location string
batchPredictionJob string
Returns
TypeDescription
string

{string} Resource name string.

checkCreateDatasetProgress(name)

checkCreateDatasetProgress(name: string): Promise<LROperation<protos.google.cloud.aiplatform.v1beta1.Dataset, protos.google.cloud.aiplatform.v1beta1.CreateDatasetOperationMetadata>>;

Check the status of the long running operation returned by createDataset().

Parameter
NameDescription
name string

The operation name that will be passed.

Returns
TypeDescription
Promise<LROperation<protos.google.cloud.aiplatform.v1beta1.Dataset, protos.google.cloud.aiplatform.v1beta1.CreateDatasetOperationMetadata>>

{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

checkDeleteDatasetProgress(name)

checkDeleteDatasetProgress(name: string): Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.aiplatform.v1beta1.DeleteOperationMetadata>>;

Check the status of the long running operation returned by deleteDataset().

Parameter
NameDescription
name string

The operation name that will be passed.

Returns
TypeDescription
Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.aiplatform.v1beta1.DeleteOperationMetadata>>

{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

checkExportDataProgress(name)

checkExportDataProgress(name: string): Promise<LROperation<protos.google.cloud.aiplatform.v1beta1.ExportDataResponse, protos.google.cloud.aiplatform.v1beta1.ExportDataOperationMetadata>>;

Check the status of the long running operation returned by exportData().

Parameter
NameDescription
name string

The operation name that will be passed.

Returns
TypeDescription
Promise<LROperation<protos.google.cloud.aiplatform.v1beta1.ExportDataResponse, protos.google.cloud.aiplatform.v1beta1.ExportDataOperationMetadata>>

{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

checkImportDataProgress(name)

checkImportDataProgress(name: string): Promise<LROperation<protos.google.cloud.aiplatform.v1beta1.ImportDataResponse, protos.google.cloud.aiplatform.v1beta1.ImportDataOperationMetadata>>;

Check the status of the long running operation returned by importData().

Parameter
NameDescription
name string

The operation name that will be passed.

Returns
TypeDescription
Promise<LROperation<protos.google.cloud.aiplatform.v1beta1.ImportDataResponse, protos.google.cloud.aiplatform.v1beta1.ImportDataOperationMetadata>>

{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

close()

close(): Promise<void>;

Terminate the gRPC channel and close the client.

The client will no longer be usable and all future behavior is undefined.

Returns
TypeDescription
Promise<void>

{Promise} A promise that resolves when the client is closed.

contextPath(project, location, metadataStore, context)

contextPath(project: string, location: string, metadataStore: string, context: string): string;

Return a fully-qualified context resource name string.

Parameters
NameDescription
project string
location string
metadataStore string
context string
Returns
TypeDescription
string

{string} Resource name string.

createDataset(request, options)

createDataset(request?: protos.google.cloud.aiplatform.v1beta1.ICreateDatasetRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.aiplatform.v1beta1.IDataset, protos.google.cloud.aiplatform.v1beta1.ICreateDatasetOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;
Parameters
NameDescription
request protos.google.cloud.aiplatform.v1beta1.ICreateDatasetRequest
options CallOptions
Returns
TypeDescription
Promise<[ LROperation<protos.google.cloud.aiplatform.v1beta1.IDataset, protos.google.cloud.aiplatform.v1beta1.ICreateDatasetOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined ]>

createDataset(request, options, callback)

createDataset(request: protos.google.cloud.aiplatform.v1beta1.ICreateDatasetRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.aiplatform.v1beta1.IDataset, protos.google.cloud.aiplatform.v1beta1.ICreateDatasetOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.aiplatform.v1beta1.ICreateDatasetRequest
options CallOptions
callback Callback<LROperation<protos.google.cloud.aiplatform.v1beta1.IDataset, protos.google.cloud.aiplatform.v1beta1.ICreateDatasetOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

createDataset(request, callback)

createDataset(request: protos.google.cloud.aiplatform.v1beta1.ICreateDatasetRequest, callback: Callback<LROperation<protos.google.cloud.aiplatform.v1beta1.IDataset, protos.google.cloud.aiplatform.v1beta1.ICreateDatasetOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.aiplatform.v1beta1.ICreateDatasetRequest
callback Callback<LROperation<protos.google.cloud.aiplatform.v1beta1.IDataset, protos.google.cloud.aiplatform.v1beta1.ICreateDatasetOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

customJobPath(project, location, customJob)

customJobPath(project: string, location: string, customJob: string): string;

Return a fully-qualified customJob resource name string.

Parameters
NameDescription
project string
location string
customJob string
Returns
TypeDescription
string

{string} Resource name string.

dataItemPath(project, location, dataset, dataItem)

dataItemPath(project: string, location: string, dataset: string, dataItem: string): string;

Return a fully-qualified dataItem resource name string.

Parameters
NameDescription
project string
location string
dataset string
dataItem string
Returns
TypeDescription
string

{string} Resource name string.

dataLabelingJobPath(project, location, dataLabelingJob)

dataLabelingJobPath(project: string, location: string, dataLabelingJob: string): string;

Return a fully-qualified dataLabelingJob resource name string.

Parameters
NameDescription
project string
location string
dataLabelingJob string
Returns
TypeDescription
string

{string} Resource name string.

datasetPath(project, location, dataset)

datasetPath(project: string, location: string, dataset: string): string;

Return a fully-qualified dataset resource name string.

Parameters
NameDescription
project string
location string
dataset string
Returns
TypeDescription
string

{string} Resource name string.

deleteDataset(request, options)

deleteDataset(request?: protos.google.cloud.aiplatform.v1beta1.IDeleteDatasetRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.aiplatform.v1beta1.IDeleteOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;
Parameters
NameDescription
request protos.google.cloud.aiplatform.v1beta1.IDeleteDatasetRequest
options CallOptions
Returns
TypeDescription
Promise<[ LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.aiplatform.v1beta1.IDeleteOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined ]>

deleteDataset(request, options, callback)

deleteDataset(request: protos.google.cloud.aiplatform.v1beta1.IDeleteDatasetRequest, options: CallOptions, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.aiplatform.v1beta1.IDeleteOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.aiplatform.v1beta1.IDeleteDatasetRequest
options CallOptions
callback Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.aiplatform.v1beta1.IDeleteOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

deleteDataset(request, callback)

deleteDataset(request: protos.google.cloud.aiplatform.v1beta1.IDeleteDatasetRequest, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.aiplatform.v1beta1.IDeleteOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.aiplatform.v1beta1.IDeleteDatasetRequest
callback Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.aiplatform.v1beta1.IDeleteOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

endpointPath(project, location, endpoint)

endpointPath(project: string, location: string, endpoint: string): string;

Return a fully-qualified endpoint resource name string.

Parameters
NameDescription
project string
location string
endpoint string
Returns
TypeDescription
string

{string} Resource name string.

entityTypePath(project, location, featurestore, entityType)

entityTypePath(project: string, location: string, featurestore: string, entityType: string): string;

Return a fully-qualified entityType resource name string.

Parameters
NameDescription
project string
location string
featurestore string
entityType string
Returns
TypeDescription
string

{string} Resource name string.

executionPath(project, location, metadataStore, execution)

executionPath(project: string, location: string, metadataStore: string, execution: string): string;

Return a fully-qualified execution resource name string.

Parameters
NameDescription
project string
location string
metadataStore string
execution string
Returns
TypeDescription
string

{string} Resource name string.

exportData(request, options)

exportData(request?: protos.google.cloud.aiplatform.v1beta1.IExportDataRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.aiplatform.v1beta1.IExportDataResponse, protos.google.cloud.aiplatform.v1beta1.IExportDataOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;
Parameters
NameDescription
request protos.google.cloud.aiplatform.v1beta1.IExportDataRequest
options CallOptions
Returns
TypeDescription
Promise<[ LROperation<protos.google.cloud.aiplatform.v1beta1.IExportDataResponse, protos.google.cloud.aiplatform.v1beta1.IExportDataOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined ]>

exportData(request, options, callback)

exportData(request: protos.google.cloud.aiplatform.v1beta1.IExportDataRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.aiplatform.v1beta1.IExportDataResponse, protos.google.cloud.aiplatform.v1beta1.IExportDataOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.aiplatform.v1beta1.IExportDataRequest
options CallOptions
callback Callback<LROperation<protos.google.cloud.aiplatform.v1beta1.IExportDataResponse, protos.google.cloud.aiplatform.v1beta1.IExportDataOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

exportData(request, callback)

exportData(request: protos.google.cloud.aiplatform.v1beta1.IExportDataRequest, callback: Callback<LROperation<protos.google.cloud.aiplatform.v1beta1.IExportDataResponse, protos.google.cloud.aiplatform.v1beta1.IExportDataOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.aiplatform.v1beta1.IExportDataRequest
callback Callback<LROperation<protos.google.cloud.aiplatform.v1beta1.IExportDataResponse, protos.google.cloud.aiplatform.v1beta1.IExportDataOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

featurePath(project, location, featurestore, entityType, feature)

featurePath(project: string, location: string, featurestore: string, entityType: string, feature: string): string;

Return a fully-qualified feature resource name string.

Parameters
NameDescription
project string
location string
featurestore string
entityType string
feature string
Returns
TypeDescription
string

{string} Resource name string.

featurestorePath(project, location, featurestore)

featurestorePath(project: string, location: string, featurestore: string): string;

Return a fully-qualified featurestore resource name string.

Parameters
NameDescription
project string
location string
featurestore string
Returns
TypeDescription
string

{string} Resource name string.

getAnnotationSpec(request, options)

getAnnotationSpec(request?: protos.google.cloud.aiplatform.v1beta1.IGetAnnotationSpecRequest, options?: CallOptions): Promise<[
        protos.google.cloud.aiplatform.v1beta1.IAnnotationSpec,
        (protos.google.cloud.aiplatform.v1beta1.IGetAnnotationSpecRequest | undefined),
        {} | undefined
    ]>;
Parameters
NameDescription
request protos.google.cloud.aiplatform.v1beta1.IGetAnnotationSpecRequest
options CallOptions
Returns
TypeDescription
Promise<[ protos.google.cloud.aiplatform.v1beta1.IAnnotationSpec, (protos.google.cloud.aiplatform.v1beta1.IGetAnnotationSpecRequest | undefined), {} | undefined ]>

getAnnotationSpec(request, options, callback)

getAnnotationSpec(request: protos.google.cloud.aiplatform.v1beta1.IGetAnnotationSpecRequest, options: CallOptions, callback: Callback<protos.google.cloud.aiplatform.v1beta1.IAnnotationSpec, protos.google.cloud.aiplatform.v1beta1.IGetAnnotationSpecRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.aiplatform.v1beta1.IGetAnnotationSpecRequest
options CallOptions
callback Callback<protos.google.cloud.aiplatform.v1beta1.IAnnotationSpec, protos.google.cloud.aiplatform.v1beta1.IGetAnnotationSpecRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

getAnnotationSpec(request, callback)

getAnnotationSpec(request: protos.google.cloud.aiplatform.v1beta1.IGetAnnotationSpecRequest, callback: Callback<protos.google.cloud.aiplatform.v1beta1.IAnnotationSpec, protos.google.cloud.aiplatform.v1beta1.IGetAnnotationSpecRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.aiplatform.v1beta1.IGetAnnotationSpecRequest
callback Callback<protos.google.cloud.aiplatform.v1beta1.IAnnotationSpec, protos.google.cloud.aiplatform.v1beta1.IGetAnnotationSpecRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

getDataset(request, options)

getDataset(request?: protos.google.cloud.aiplatform.v1beta1.IGetDatasetRequest, options?: CallOptions): Promise<[
        protos.google.cloud.aiplatform.v1beta1.IDataset,
        protos.google.cloud.aiplatform.v1beta1.IGetDatasetRequest | undefined,
        {} | undefined
    ]>;
Parameters
NameDescription
request protos.google.cloud.aiplatform.v1beta1.IGetDatasetRequest
options CallOptions
Returns
TypeDescription
Promise<[ protos.google.cloud.aiplatform.v1beta1.IDataset, protos.google.cloud.aiplatform.v1beta1.IGetDatasetRequest | undefined, {} | undefined ]>

getDataset(request, options, callback)

getDataset(request: protos.google.cloud.aiplatform.v1beta1.IGetDatasetRequest, options: CallOptions, callback: Callback<protos.google.cloud.aiplatform.v1beta1.IDataset, protos.google.cloud.aiplatform.v1beta1.IGetDatasetRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.aiplatform.v1beta1.IGetDatasetRequest
options CallOptions
callback Callback<protos.google.cloud.aiplatform.v1beta1.IDataset, protos.google.cloud.aiplatform.v1beta1.IGetDatasetRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

getDataset(request, callback)

getDataset(request: protos.google.cloud.aiplatform.v1beta1.IGetDatasetRequest, callback: Callback<protos.google.cloud.aiplatform.v1beta1.IDataset, protos.google.cloud.aiplatform.v1beta1.IGetDatasetRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.aiplatform.v1beta1.IGetDatasetRequest
callback Callback<protos.google.cloud.aiplatform.v1beta1.IDataset, protos.google.cloud.aiplatform.v1beta1.IGetDatasetRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

getProjectId()

getProjectId(): Promise<string>;
Returns
TypeDescription
Promise<string>

getProjectId(callback)

getProjectId(callback: Callback<string, undefined, undefined>): void;
Parameter
NameDescription
callback Callback<string, undefined, undefined>
Returns
TypeDescription
void

hyperparameterTuningJobPath(project, location, hyperparameterTuningJob)

hyperparameterTuningJobPath(project: string, location: string, hyperparameterTuningJob: string): string;

Return a fully-qualified hyperparameterTuningJob resource name string.

Parameters
NameDescription
project string
location string
hyperparameterTuningJob string
Returns
TypeDescription
string

{string} Resource name string.

importData(request, options)

importData(request?: protos.google.cloud.aiplatform.v1beta1.IImportDataRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.aiplatform.v1beta1.IImportDataResponse, protos.google.cloud.aiplatform.v1beta1.IImportDataOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;
Parameters
NameDescription
request protos.google.cloud.aiplatform.v1beta1.IImportDataRequest
options CallOptions
Returns
TypeDescription
Promise<[ LROperation<protos.google.cloud.aiplatform.v1beta1.IImportDataResponse, protos.google.cloud.aiplatform.v1beta1.IImportDataOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined ]>

importData(request, options, callback)

importData(request: protos.google.cloud.aiplatform.v1beta1.IImportDataRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.aiplatform.v1beta1.IImportDataResponse, protos.google.cloud.aiplatform.v1beta1.IImportDataOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.aiplatform.v1beta1.IImportDataRequest
options CallOptions
callback Callback<LROperation<protos.google.cloud.aiplatform.v1beta1.IImportDataResponse, protos.google.cloud.aiplatform.v1beta1.IImportDataOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

importData(request, callback)

importData(request: protos.google.cloud.aiplatform.v1beta1.IImportDataRequest, callback: Callback<LROperation<protos.google.cloud.aiplatform.v1beta1.IImportDataResponse, protos.google.cloud.aiplatform.v1beta1.IImportDataOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.aiplatform.v1beta1.IImportDataRequest
callback Callback<LROperation<protos.google.cloud.aiplatform.v1beta1.IImportDataResponse, protos.google.cloud.aiplatform.v1beta1.IImportDataOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

indexEndpointPath(project, location, indexEndpoint)

indexEndpointPath(project: string, location: string, indexEndpoint: string): string;

Return a fully-qualified indexEndpoint resource name string.

Parameters
NameDescription
project string
location string
indexEndpoint string
Returns
TypeDescription
string

{string} Resource name string.

indexPath(project, location, index)

indexPath(project: string, location: string, index: string): string;

Return a fully-qualified index resource name string.

Parameters
NameDescription
project string
location string
index string
Returns
TypeDescription
string

{string} Resource name string.

initialize()

initialize(): Promise<{
        [name: string]: Function;
    }>;

Initialize the client. Performs asynchronous operations (such as authentication) and prepares the client. This function will be called automatically when any class method is called for the first time, but if you need to initialize it before calling an actual method, feel free to call initialize() directly.

You can await on this method if you want to make sure the client is initialized.

Returns
TypeDescription
Promise<{ [name: string]: Function; }>

{Promise} A promise that resolves to an authenticated service stub.

listAnnotations(request, options)

listAnnotations(request?: protos.google.cloud.aiplatform.v1beta1.IListAnnotationsRequest, options?: CallOptions): Promise<[
        protos.google.cloud.aiplatform.v1beta1.IAnnotation[],
        protos.google.cloud.aiplatform.v1beta1.IListAnnotationsRequest | null,
        protos.google.cloud.aiplatform.v1beta1.IListAnnotationsResponse
    ]>;
Parameters
NameDescription
request protos.google.cloud.aiplatform.v1beta1.IListAnnotationsRequest
options CallOptions
Returns
TypeDescription
Promise<[ protos.google.cloud.aiplatform.v1beta1.IAnnotation[], protos.google.cloud.aiplatform.v1beta1.IListAnnotationsRequest | null, protos.google.cloud.aiplatform.v1beta1.IListAnnotationsResponse ]>

listAnnotations(request, options, callback)

listAnnotations(request: protos.google.cloud.aiplatform.v1beta1.IListAnnotationsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.aiplatform.v1beta1.IListAnnotationsRequest, protos.google.cloud.aiplatform.v1beta1.IListAnnotationsResponse | null | undefined, protos.google.cloud.aiplatform.v1beta1.IAnnotation>): void;
Parameters
NameDescription
request protos.google.cloud.aiplatform.v1beta1.IListAnnotationsRequest
options CallOptions
callback PaginationCallback<protos.google.cloud.aiplatform.v1beta1.IListAnnotationsRequest, protos.google.cloud.aiplatform.v1beta1.IListAnnotationsResponse | null | undefined, protos.google.cloud.aiplatform.v1beta1.IAnnotation>
Returns
TypeDescription
void

listAnnotations(request, callback)

listAnnotations(request: protos.google.cloud.aiplatform.v1beta1.IListAnnotationsRequest, callback: PaginationCallback<protos.google.cloud.aiplatform.v1beta1.IListAnnotationsRequest, protos.google.cloud.aiplatform.v1beta1.IListAnnotationsResponse | null | undefined, protos.google.cloud.aiplatform.v1beta1.IAnnotation>): void;
Parameters
NameDescription
request protos.google.cloud.aiplatform.v1beta1.IListAnnotationsRequest
callback PaginationCallback<protos.google.cloud.aiplatform.v1beta1.IListAnnotationsRequest, protos.google.cloud.aiplatform.v1beta1.IListAnnotationsResponse | null | undefined, protos.google.cloud.aiplatform.v1beta1.IAnnotation>
Returns
TypeDescription
void

listAnnotationsAsync(request, options)

listAnnotationsAsync(request?: protos.google.cloud.aiplatform.v1beta1.IListAnnotationsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.aiplatform.v1beta1.IAnnotation>;

Equivalent to listAnnotations, but returns an iterable object.

for-await-of syntax is used with the iterable to get response elements on-demand.

Parameters
NameDescription
request protos.google.cloud.aiplatform.v1beta1.IListAnnotationsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
AsyncIterable<protos.google.cloud.aiplatform.v1beta1.IAnnotation>

{Object} An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). When you iterate the returned iterable, each element will be an object representing [Annotation]. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

listAnnotationsStream(request, options)

listAnnotationsStream(request?: protos.google.cloud.aiplatform.v1beta1.IListAnnotationsRequest, options?: CallOptions): Transform;

Equivalent to method.name.toCamelCase(), but returns a NodeJS Stream object.

Parameters
NameDescription
request protos.google.cloud.aiplatform.v1beta1.IListAnnotationsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Transform

{Stream} An object stream which emits an object representing [Annotation] on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listAnnotationsAsync() method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

listDataItems(request, options)

listDataItems(request?: protos.google.cloud.aiplatform.v1beta1.IListDataItemsRequest, options?: CallOptions): Promise<[
        protos.google.cloud.aiplatform.v1beta1.IDataItem[],
        protos.google.cloud.aiplatform.v1beta1.IListDataItemsRequest | null,
        protos.google.cloud.aiplatform.v1beta1.IListDataItemsResponse
    ]>;
Parameters
NameDescription
request protos.google.cloud.aiplatform.v1beta1.IListDataItemsRequest
options CallOptions
Returns
TypeDescription
Promise<[ protos.google.cloud.aiplatform.v1beta1.IDataItem[], protos.google.cloud.aiplatform.v1beta1.IListDataItemsRequest | null, protos.google.cloud.aiplatform.v1beta1.IListDataItemsResponse ]>

listDataItems(request, options, callback)

listDataItems(request: protos.google.cloud.aiplatform.v1beta1.IListDataItemsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.aiplatform.v1beta1.IListDataItemsRequest, protos.google.cloud.aiplatform.v1beta1.IListDataItemsResponse | null | undefined, protos.google.cloud.aiplatform.v1beta1.IDataItem>): void;
Parameters
NameDescription
request protos.google.cloud.aiplatform.v1beta1.IListDataItemsRequest
options CallOptions
callback PaginationCallback<protos.google.cloud.aiplatform.v1beta1.IListDataItemsRequest, protos.google.cloud.aiplatform.v1beta1.IListDataItemsResponse | null | undefined, protos.google.cloud.aiplatform.v1beta1.IDataItem>
Returns
TypeDescription
void

listDataItems(request, callback)

listDataItems(request: protos.google.cloud.aiplatform.v1beta1.IListDataItemsRequest, callback: PaginationCallback<protos.google.cloud.aiplatform.v1beta1.IListDataItemsRequest, protos.google.cloud.aiplatform.v1beta1.IListDataItemsResponse | null | undefined, protos.google.cloud.aiplatform.v1beta1.IDataItem>): void;
Parameters
NameDescription
request protos.google.cloud.aiplatform.v1beta1.IListDataItemsRequest
callback PaginationCallback<protos.google.cloud.aiplatform.v1beta1.IListDataItemsRequest, protos.google.cloud.aiplatform.v1beta1.IListDataItemsResponse | null | undefined, protos.google.cloud.aiplatform.v1beta1.IDataItem>
Returns
TypeDescription
void

listDataItemsAsync(request, options)

listDataItemsAsync(request?: protos.google.cloud.aiplatform.v1beta1.IListDataItemsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.aiplatform.v1beta1.IDataItem>;

Equivalent to listDataItems, but returns an iterable object.

for-await-of syntax is used with the iterable to get response elements on-demand.

Parameters
NameDescription
request protos.google.cloud.aiplatform.v1beta1.IListDataItemsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
AsyncIterable<protos.google.cloud.aiplatform.v1beta1.IDataItem>

{Object} An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). When you iterate the returned iterable, each element will be an object representing [DataItem]. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

listDataItemsStream(request, options)

listDataItemsStream(request?: protos.google.cloud.aiplatform.v1beta1.IListDataItemsRequest, options?: CallOptions): Transform;

Equivalent to method.name.toCamelCase(), but returns a NodeJS Stream object.

Parameters
NameDescription
request protos.google.cloud.aiplatform.v1beta1.IListDataItemsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Transform

{Stream} An object stream which emits an object representing [DataItem] on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listDataItemsAsync() method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

listDatasets(request, options)

listDatasets(request?: protos.google.cloud.aiplatform.v1beta1.IListDatasetsRequest, options?: CallOptions): Promise<[
        protos.google.cloud.aiplatform.v1beta1.IDataset[],
        protos.google.cloud.aiplatform.v1beta1.IListDatasetsRequest | null,
        protos.google.cloud.aiplatform.v1beta1.IListDatasetsResponse
    ]>;
Parameters
NameDescription
request protos.google.cloud.aiplatform.v1beta1.IListDatasetsRequest
options CallOptions
Returns
TypeDescription
Promise<[ protos.google.cloud.aiplatform.v1beta1.IDataset[], protos.google.cloud.aiplatform.v1beta1.IListDatasetsRequest | null, protos.google.cloud.aiplatform.v1beta1.IListDatasetsResponse ]>

listDatasets(request, options, callback)

listDatasets(request: protos.google.cloud.aiplatform.v1beta1.IListDatasetsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.aiplatform.v1beta1.IListDatasetsRequest, protos.google.cloud.aiplatform.v1beta1.IListDatasetsResponse | null | undefined, protos.google.cloud.aiplatform.v1beta1.IDataset>): void;
Parameters
NameDescription
request protos.google.cloud.aiplatform.v1beta1.IListDatasetsRequest
options CallOptions
callback PaginationCallback<protos.google.cloud.aiplatform.v1beta1.IListDatasetsRequest, protos.google.cloud.aiplatform.v1beta1.IListDatasetsResponse | null | undefined, protos.google.cloud.aiplatform.v1beta1.IDataset>
Returns
TypeDescription
void

listDatasets(request, callback)

listDatasets(request: protos.google.cloud.aiplatform.v1beta1.IListDatasetsRequest, callback: PaginationCallback<protos.google.cloud.aiplatform.v1beta1.IListDatasetsRequest, protos.google.cloud.aiplatform.v1beta1.IListDatasetsResponse | null | undefined, protos.google.cloud.aiplatform.v1beta1.IDataset>): void;
Parameters
NameDescription
request protos.google.cloud.aiplatform.v1beta1.IListDatasetsRequest
callback PaginationCallback<protos.google.cloud.aiplatform.v1beta1.IListDatasetsRequest, protos.google.cloud.aiplatform.v1beta1.IListDatasetsResponse | null | undefined, protos.google.cloud.aiplatform.v1beta1.IDataset>
Returns
TypeDescription
void

listDatasetsAsync(request, options)

listDatasetsAsync(request?: protos.google.cloud.aiplatform.v1beta1.IListDatasetsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.aiplatform.v1beta1.IDataset>;

Equivalent to listDatasets, but returns an iterable object.

for-await-of syntax is used with the iterable to get response elements on-demand.

Parameters
NameDescription
request protos.google.cloud.aiplatform.v1beta1.IListDatasetsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
AsyncIterable<protos.google.cloud.aiplatform.v1beta1.IDataset>

{Object} An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). When you iterate the returned iterable, each element will be an object representing [Dataset]. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

listDatasetsStream(request, options)

listDatasetsStream(request?: protos.google.cloud.aiplatform.v1beta1.IListDatasetsRequest, options?: CallOptions): Transform;

Equivalent to method.name.toCamelCase(), but returns a NodeJS Stream object.

Parameters
NameDescription
request protos.google.cloud.aiplatform.v1beta1.IListDatasetsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Transform

{Stream} An object stream which emits an object representing [Dataset] on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listDatasetsAsync() method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

locationPath(project, location)

locationPath(project: string, location: string): string;

Return a fully-qualified location resource name string.

Parameters
NameDescription
project string
location string
Returns
TypeDescription
string

{string} Resource name string.

matchAnnotationFromAnnotationName(annotationName)

matchAnnotationFromAnnotationName(annotationName: string): string | number;

Parse the annotation from Annotation resource.

Parameter
NameDescription
annotationName string

A fully-qualified path representing Annotation resource.

Returns
TypeDescription
string | number

{string} A string representing the annotation.

matchAnnotationSpecFromAnnotationSpecName(annotationSpecName)

matchAnnotationSpecFromAnnotationSpecName(annotationSpecName: string): string | number;

Parse the annotation_spec from AnnotationSpec resource.

Parameter
NameDescription
annotationSpecName string

A fully-qualified path representing AnnotationSpec resource.

Returns
TypeDescription
string | number

{string} A string representing the annotation_spec.

matchArtifactFromArtifactName(artifactName)

matchArtifactFromArtifactName(artifactName: string): string | number;

Parse the artifact from Artifact resource.

Parameter
NameDescription
artifactName string

A fully-qualified path representing Artifact resource.

Returns
TypeDescription
string | number

{string} A string representing the artifact.

matchBatchPredictionJobFromBatchPredictionJobName(batchPredictionJobName)

matchBatchPredictionJobFromBatchPredictionJobName(batchPredictionJobName: string): string | number;

Parse the batch_prediction_job from BatchPredictionJob resource.

Parameter
NameDescription
batchPredictionJobName string

A fully-qualified path representing BatchPredictionJob resource.

Returns
TypeDescription
string | number

{string} A string representing the batch_prediction_job.

matchContextFromContextName(contextName)

matchContextFromContextName(contextName: string): string | number;

Parse the context from Context resource.

Parameter
NameDescription
contextName string

A fully-qualified path representing Context resource.

Returns
TypeDescription
string | number

{string} A string representing the context.

matchCustomJobFromCustomJobName(customJobName)

matchCustomJobFromCustomJobName(customJobName: string): string | number;

Parse the custom_job from CustomJob resource.

Parameter
NameDescription
customJobName string

A fully-qualified path representing CustomJob resource.

Returns
TypeDescription
string | number

{string} A string representing the custom_job.

matchDataItemFromAnnotationName(annotationName)

matchDataItemFromAnnotationName(annotationName: string): string | number;

Parse the data_item from Annotation resource.

Parameter
NameDescription
annotationName string

A fully-qualified path representing Annotation resource.

Returns
TypeDescription
string | number

{string} A string representing the data_item.

matchDataItemFromDataItemName(dataItemName)

matchDataItemFromDataItemName(dataItemName: string): string | number;

Parse the data_item from DataItem resource.

Parameter
NameDescription
dataItemName string

A fully-qualified path representing DataItem resource.

Returns
TypeDescription
string | number

{string} A string representing the data_item.

matchDataLabelingJobFromDataLabelingJobName(dataLabelingJobName)

matchDataLabelingJobFromDataLabelingJobName(dataLabelingJobName: string): string | number;

Parse the data_labeling_job from DataLabelingJob resource.

Parameter
NameDescription
dataLabelingJobName string

A fully-qualified path representing DataLabelingJob resource.

Returns
TypeDescription
string | number

{string} A string representing the data_labeling_job.

matchDatasetFromAnnotationName(annotationName)

matchDatasetFromAnnotationName(annotationName: string): string | number;

Parse the dataset from Annotation resource.

Parameter
NameDescription
annotationName string

A fully-qualified path representing Annotation resource.

Returns
TypeDescription
string | number

{string} A string representing the dataset.

matchDatasetFromAnnotationSpecName(annotationSpecName)

matchDatasetFromAnnotationSpecName(annotationSpecName: string): string | number;

Parse the dataset from AnnotationSpec resource.

Parameter
NameDescription
annotationSpecName string

A fully-qualified path representing AnnotationSpec resource.

Returns
TypeDescription
string | number

{string} A string representing the dataset.

matchDatasetFromDataItemName(dataItemName)

matchDatasetFromDataItemName(dataItemName: string): string | number;

Parse the dataset from DataItem resource.

Parameter
NameDescription
dataItemName string

A fully-qualified path representing DataItem resource.

Returns
TypeDescription
string | number

{string} A string representing the dataset.

matchDatasetFromDatasetName(datasetName)

matchDatasetFromDatasetName(datasetName: string): string | number;

Parse the dataset from Dataset resource.

Parameter
NameDescription
datasetName string

A fully-qualified path representing Dataset resource.

Returns
TypeDescription
string | number

{string} A string representing the dataset.

matchEndpointFromEndpointName(endpointName)

matchEndpointFromEndpointName(endpointName: string): string | number;

Parse the endpoint from Endpoint resource.

Parameter
NameDescription
endpointName string

A fully-qualified path representing Endpoint resource.

Returns
TypeDescription
string | number

{string} A string representing the endpoint.

matchEntityTypeFromEntityTypeName(entityTypeName)

matchEntityTypeFromEntityTypeName(entityTypeName: string): string | number;

Parse the entity_type from EntityType resource.

Parameter
NameDescription
entityTypeName string

A fully-qualified path representing EntityType resource.

Returns
TypeDescription
string | number

{string} A string representing the entity_type.

matchEntityTypeFromFeatureName(featureName)

matchEntityTypeFromFeatureName(featureName: string): string | number;

Parse the entity_type from Feature resource.

Parameter
NameDescription
featureName string

A fully-qualified path representing Feature resource.

Returns
TypeDescription
string | number

{string} A string representing the entity_type.

matchEvaluationFromModelEvaluationName(modelEvaluationName)

matchEvaluationFromModelEvaluationName(modelEvaluationName: string): string | number;

Parse the evaluation from ModelEvaluation resource.

Parameter
NameDescription
modelEvaluationName string

A fully-qualified path representing ModelEvaluation resource.

Returns
TypeDescription
string | number

{string} A string representing the evaluation.

matchEvaluationFromModelEvaluationSliceName(modelEvaluationSliceName)

matchEvaluationFromModelEvaluationSliceName(modelEvaluationSliceName: string): string | number;

Parse the evaluation from ModelEvaluationSlice resource.

Parameter
NameDescription
modelEvaluationSliceName string

A fully-qualified path representing ModelEvaluationSlice resource.

Returns
TypeDescription
string | number

{string} A string representing the evaluation.

matchExecutionFromExecutionName(executionName)

matchExecutionFromExecutionName(executionName: string): string | number;

Parse the execution from Execution resource.

Parameter
NameDescription
executionName string

A fully-qualified path representing Execution resource.

Returns
TypeDescription
string | number

{string} A string representing the execution.

matchExperimentFromTensorboardExperimentName(tensorboardExperimentName)

matchExperimentFromTensorboardExperimentName(tensorboardExperimentName: string): string | number;

Parse the experiment from TensorboardExperiment resource.

Parameter
NameDescription
tensorboardExperimentName string

A fully-qualified path representing TensorboardExperiment resource.

Returns
TypeDescription
string | number

{string} A string representing the experiment.

matchExperimentFromTensorboardRunName(tensorboardRunName)

matchExperimentFromTensorboardRunName(tensorboardRunName: string): string | number;

Parse the experiment from TensorboardRun resource.

Parameter
NameDescription
tensorboardRunName string

A fully-qualified path representing TensorboardRun resource.

Returns
TypeDescription
string | number

{string} A string representing the experiment.

matchExperimentFromTensorboardTimeSeriesName(tensorboardTimeSeriesName)

matchExperimentFromTensorboardTimeSeriesName(tensorboardTimeSeriesName: string): string | number;

Parse the experiment from TensorboardTimeSeries resource.

Parameter
NameDescription
tensorboardTimeSeriesName string

A fully-qualified path representing TensorboardTimeSeries resource.

Returns
TypeDescription
string | number

{string} A string representing the experiment.

matchFeatureFromFeatureName(featureName)

matchFeatureFromFeatureName(featureName: string): string | number;

Parse the feature from Feature resource.

Parameter
NameDescription
featureName string

A fully-qualified path representing Feature resource.

Returns
TypeDescription
string | number

{string} A string representing the feature.

matchFeaturestoreFromEntityTypeName(entityTypeName)

matchFeaturestoreFromEntityTypeName(entityTypeName: string): string | number;

Parse the featurestore from EntityType resource.

Parameter
NameDescription
entityTypeName string

A fully-qualified path representing EntityType resource.

Returns
TypeDescription
string | number

{string} A string representing the featurestore.

matchFeaturestoreFromFeatureName(featureName)

matchFeaturestoreFromFeatureName(featureName: string): string | number;

Parse the featurestore from Feature resource.

Parameter
NameDescription
featureName string

A fully-qualified path representing Feature resource.

Returns
TypeDescription
string | number

{string} A string representing the featurestore.

matchFeaturestoreFromFeaturestoreName(featurestoreName)

matchFeaturestoreFromFeaturestoreName(featurestoreName: string): string | number;

Parse the featurestore from Featurestore resource.

Parameter
NameDescription
featurestoreName string

A fully-qualified path representing Featurestore resource.

Returns
TypeDescription
string | number

{string} A string representing the featurestore.

matchHyperparameterTuningJobFromHyperparameterTuningJobName(hyperparameterTuningJobName)

matchHyperparameterTuningJobFromHyperparameterTuningJobName(hyperparameterTuningJobName: string): string | number;

Parse the hyperparameter_tuning_job from HyperparameterTuningJob resource.

Parameter
NameDescription
hyperparameterTuningJobName string

A fully-qualified path representing HyperparameterTuningJob resource.

Returns
TypeDescription
string | number

{string} A string representing the hyperparameter_tuning_job.

matchIndexEndpointFromIndexEndpointName(indexEndpointName)

matchIndexEndpointFromIndexEndpointName(indexEndpointName: string): string | number;

Parse the index_endpoint from IndexEndpoint resource.

Parameter
NameDescription
indexEndpointName string

A fully-qualified path representing IndexEndpoint resource.

Returns
TypeDescription
string | number

{string} A string representing the index_endpoint.

matchIndexFromIndexName(indexName)

matchIndexFromIndexName(indexName: string): string | number;

Parse the index from Index resource.

Parameter
NameDescription
indexName