TensorboardService v1beta1
Package
@google-cloud/aiplatform
Constructors
constructor(opts?: ClientOptions);
Construct an instance of TensorboardServiceClient.
Parameter
Name | Description |
opts |
ClientOptions
|
Properties
static get apiEndpoint(): string;
The DNS address for this API service - same as servicePath(), exists for compatibility reasons.
Property Value
Property Value
Type | Description |
gax.GoogleAuth | |
descriptors: Descriptors;
Property Value
Type | Description |
Descriptors | |
innerApiCalls: {
[name: string]: Function;
};
Property Value
Type | Description |
{
[name: string]: Function;
} | |
operationsClient: gax.OperationsClient;
Property Value
Type | Description |
gax.OperationsClient | |
pathTemplates: {
[name: string]: gax.PathTemplate;
};
Property Value
Type | Description |
{
[name: string]: gax.PathTemplate;
} | |
static get port(): number;
The port for this API service.
Property Value
static get scopes(): string[];
The scopes needed to make gRPC calls for every method defined in this service.
Property Value
static get servicePath(): string;
The DNS address for this API service.
Property Value
tensorboardServiceStub?: Promise<{
[name: string]: Function;
}>;
Property Value
Type | Description |
Promise<{
[name: string]: Function;
}> | |
warn: (code: string, message: string, warnType?: string) => void;
Property Value
Type | Description |
(code: string, message: string, warnType?: string) => void | |
Methods
annotationPath(project: string, location: string, dataset: string, dataItem: string, annotation: string): string;
Return a fully-qualified annotation resource name string.
Parameters
Name | Description |
project |
string
|
location |
string
|
dataset |
string
|
dataItem |
string
|
annotation |
string
|
Returns
Type | Description |
string | {string} Resource name string.
|
annotationSpecPath(project: string, location: string, dataset: string, annotationSpec: string): string;
Return a fully-qualified annotationSpec resource name string.
Parameters
Name | Description |
project |
string
|
location |
string
|
dataset |
string
|
annotationSpec |
string
|
Returns
Type | Description |
string | {string} Resource name string.
|
artifactPath(project: string, location: string, metadataStore: string, artifact: string): string;
Return a fully-qualified artifact resource name string.
Parameters
Name | Description |
project |
string
|
location |
string
|
metadataStore |
string
|
artifact |
string
|
Returns
Type | Description |
string | {string} Resource name string.
|
batchCreateTensorboardRuns(request?: protos.google.cloud.aiplatform.v1beta1.IBatchCreateTensorboardRunsRequest, options?: CallOptions): Promise<[
protos.google.cloud.aiplatform.v1beta1.IBatchCreateTensorboardRunsResponse,
(protos.google.cloud.aiplatform.v1beta1.IBatchCreateTensorboardRunsRequest | undefined),
{} | undefined
]>;
Parameters
Name | Description |
request |
protos.google.cloud.aiplatform.v1beta1.IBatchCreateTensorboardRunsRequest
|
options |
CallOptions
|
Returns
Type | Description |
Promise<[
protos.google.cloud.aiplatform.v1beta1.IBatchCreateTensorboardRunsResponse,
(protos.google.cloud.aiplatform.v1beta1.IBatchCreateTensorboardRunsRequest | undefined),
{} | undefined
]> | |
batchCreateTensorboardRuns(request: protos.google.cloud.aiplatform.v1beta1.IBatchCreateTensorboardRunsRequest, options: CallOptions, callback: Callback<protos.google.cloud.aiplatform.v1beta1.IBatchCreateTensorboardRunsResponse, protos.google.cloud.aiplatform.v1beta1.IBatchCreateTensorboardRunsRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.cloud.aiplatform.v1beta1.IBatchCreateTensorboardRunsRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.cloud.aiplatform.v1beta1.IBatchCreateTensorboardRunsResponse, protos.google.cloud.aiplatform.v1beta1.IBatchCreateTensorboardRunsRequest | null | undefined, {} | null | undefined>
|
Returns
batchCreateTensorboardRuns(request: protos.google.cloud.aiplatform.v1beta1.IBatchCreateTensorboardRunsRequest, callback: Callback<protos.google.cloud.aiplatform.v1beta1.IBatchCreateTensorboardRunsResponse, protos.google.cloud.aiplatform.v1beta1.IBatchCreateTensorboardRunsRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.cloud.aiplatform.v1beta1.IBatchCreateTensorboardRunsRequest
|
callback |
Callback<protos.google.cloud.aiplatform.v1beta1.IBatchCreateTensorboardRunsResponse, protos.google.cloud.aiplatform.v1beta1.IBatchCreateTensorboardRunsRequest | null | undefined, {} | null | undefined>
|
Returns
batchCreateTensorboardTimeSeries(request?: protos.google.cloud.aiplatform.v1beta1.IBatchCreateTensorboardTimeSeriesRequest, options?: CallOptions): Promise<[
protos.google.cloud.aiplatform.v1beta1.IBatchCreateTensorboardTimeSeriesResponse,
(protos.google.cloud.aiplatform.v1beta1.IBatchCreateTensorboardTimeSeriesRequest | undefined),
{} | undefined
]>;
Parameters
Name | Description |
request |
protos.google.cloud.aiplatform.v1beta1.IBatchCreateTensorboardTimeSeriesRequest
|
options |
CallOptions
|
Returns
Type | Description |
Promise<[
protos.google.cloud.aiplatform.v1beta1.IBatchCreateTensorboardTimeSeriesResponse,
(protos.google.cloud.aiplatform.v1beta1.IBatchCreateTensorboardTimeSeriesRequest | undefined),
{} | undefined
]> | |
batchCreateTensorboardTimeSeries(request: protos.google.cloud.aiplatform.v1beta1.IBatchCreateTensorboardTimeSeriesRequest, options: CallOptions, callback: Callback<protos.google.cloud.aiplatform.v1beta1.IBatchCreateTensorboardTimeSeriesResponse, protos.google.cloud.aiplatform.v1beta1.IBatchCreateTensorboardTimeSeriesRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.cloud.aiplatform.v1beta1.IBatchCreateTensorboardTimeSeriesRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.cloud.aiplatform.v1beta1.IBatchCreateTensorboardTimeSeriesResponse, protos.google.cloud.aiplatform.v1beta1.IBatchCreateTensorboardTimeSeriesRequest | null | undefined, {} | null | undefined>
|
Returns
batchCreateTensorboardTimeSeries(request: protos.google.cloud.aiplatform.v1beta1.IBatchCreateTensorboardTimeSeriesRequest, callback: Callback<protos.google.cloud.aiplatform.v1beta1.IBatchCreateTensorboardTimeSeriesResponse, protos.google.cloud.aiplatform.v1beta1.IBatchCreateTensorboardTimeSeriesRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.cloud.aiplatform.v1beta1.IBatchCreateTensorboardTimeSeriesRequest
|
callback |
Callback<protos.google.cloud.aiplatform.v1beta1.IBatchCreateTensorboardTimeSeriesResponse, protos.google.cloud.aiplatform.v1beta1.IBatchCreateTensorboardTimeSeriesRequest | null | undefined, {} | null | undefined>
|
Returns
batchPredictionJobPath(project: string, location: string, batchPredictionJob: string): string;
Return a fully-qualified batchPredictionJob resource name string.
Parameters
Name | Description |
project |
string
|
location |
string
|
batchPredictionJob |
string
|
Returns
Type | Description |
string | {string} Resource name string.
|
batchReadTensorboardTimeSeriesData(request?: protos.google.cloud.aiplatform.v1beta1.IBatchReadTensorboardTimeSeriesDataRequest, options?: CallOptions): Promise<[
protos.google.cloud.aiplatform.v1beta1.IBatchReadTensorboardTimeSeriesDataResponse,
(protos.google.cloud.aiplatform.v1beta1.IBatchReadTensorboardTimeSeriesDataRequest | undefined),
{} | undefined
]>;
Parameters
Name | Description |
request |
protos.google.cloud.aiplatform.v1beta1.IBatchReadTensorboardTimeSeriesDataRequest
|
options |
CallOptions
|
Returns
Type | Description |
Promise<[
protos.google.cloud.aiplatform.v1beta1.IBatchReadTensorboardTimeSeriesDataResponse,
(protos.google.cloud.aiplatform.v1beta1.IBatchReadTensorboardTimeSeriesDataRequest | undefined),
{} | undefined
]> | |
batchReadTensorboardTimeSeriesData(request: protos.google.cloud.aiplatform.v1beta1.IBatchReadTensorboardTimeSeriesDataRequest, options: CallOptions, callback: Callback<protos.google.cloud.aiplatform.v1beta1.IBatchReadTensorboardTimeSeriesDataResponse, protos.google.cloud.aiplatform.v1beta1.IBatchReadTensorboardTimeSeriesDataRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.cloud.aiplatform.v1beta1.IBatchReadTensorboardTimeSeriesDataRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.cloud.aiplatform.v1beta1.IBatchReadTensorboardTimeSeriesDataResponse, protos.google.cloud.aiplatform.v1beta1.IBatchReadTensorboardTimeSeriesDataRequest | null | undefined, {} | null | undefined>
|
Returns
batchReadTensorboardTimeSeriesData(request: protos.google.cloud.aiplatform.v1beta1.IBatchReadTensorboardTimeSeriesDataRequest, callback: Callback<protos.google.cloud.aiplatform.v1beta1.IBatchReadTensorboardTimeSeriesDataResponse, protos.google.cloud.aiplatform.v1beta1.IBatchReadTensorboardTimeSeriesDataRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.cloud.aiplatform.v1beta1.IBatchReadTensorboardTimeSeriesDataRequest
|
callback |
Callback<protos.google.cloud.aiplatform.v1beta1.IBatchReadTensorboardTimeSeriesDataResponse, protos.google.cloud.aiplatform.v1beta1.IBatchReadTensorboardTimeSeriesDataRequest | null | undefined, {} | null | undefined>
|
Returns
checkCreateTensorboardProgress(name: string): Promise<LROperation<protos.google.cloud.aiplatform.v1beta1.Tensorboard, protos.google.cloud.aiplatform.v1beta1.CreateTensorboardOperationMetadata>>;
Check the status of the long running operation returned by createTensorboard()
.
Parameter
Name | Description |
name |
string
The operation name that will be passed.
|
Returns
Type | Description |
Promise<LROperation<protos.google.cloud.aiplatform.v1beta1.Tensorboard, protos.google.cloud.aiplatform.v1beta1.CreateTensorboardOperationMetadata>> | {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.
|
Example
const decodedOperation = await checkCreateTensorboardProgress(name); console.log(decodedOperation.result); console.log(decodedOperation.done); console.log(decodedOperation.metadata);
checkDeleteTensorboardExperimentProgress(name: string): Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.aiplatform.v1beta1.DeleteOperationMetadata>>;
Check the status of the long running operation returned by deleteTensorboardExperiment()
.
Parameter
Name | Description |
name |
string
The operation name that will be passed.
|
Returns
Type | Description |
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.
|
Example
const decodedOperation = await checkDeleteTensorboardExperimentProgress(name); console.log(decodedOperation.result); console.log(decodedOperation.done); console.log(decodedOperation.metadata);
checkDeleteTensorboardProgress(name: string): Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.aiplatform.v1beta1.DeleteOperationMetadata>>;
Check the status of the long running operation returned by deleteTensorboard()
.
Parameter
Name | Description |
name |
string
The operation name that will be passed.
|
Returns
Type | Description |
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.
|
Example
const decodedOperation = await checkDeleteTensorboardProgress(name); console.log(decodedOperation.result); console.log(decodedOperation.done); console.log(decodedOperation.metadata);
checkDeleteTensorboardRunProgress(name: string): Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.aiplatform.v1beta1.DeleteOperationMetadata>>;
Check the status of the long running operation returned by deleteTensorboardRun()
.
Parameter
Name | Description |
name |
string
The operation name that will be passed.
|
Returns
Type | Description |
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.
|
Example
const decodedOperation = await checkDeleteTensorboardRunProgress(name); console.log(decodedOperation.result); console.log(decodedOperation.done); console.log(decodedOperation.metadata);
checkDeleteTensorboardTimeSeriesProgress(name: string): Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.aiplatform.v1beta1.DeleteOperationMetadata>>;
Check the status of the long running operation returned by deleteTensorboardTimeSeries()
.
Parameter
Name | Description |
name |
string
The operation name that will be passed.
|
Returns
Type | Description |
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.
|
Example
const decodedOperation = await checkDeleteTensorboardTimeSeriesProgress(name); console.log(decodedOperation.result); console.log(decodedOperation.done); console.log(decodedOperation.metadata);
checkUpdateTensorboardProgress(name: string): Promise<LROperation<protos.google.cloud.aiplatform.v1beta1.Tensorboard, protos.google.cloud.aiplatform.v1beta1.UpdateTensorboardOperationMetadata>>;
Check the status of the long running operation returned by updateTensorboard()
.
Parameter
Name | Description |
name |
string
The operation name that will be passed.
|
Returns
Type | Description |
Promise<LROperation<protos.google.cloud.aiplatform.v1beta1.Tensorboard, protos.google.cloud.aiplatform.v1beta1.UpdateTensorboardOperationMetadata>> | {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.
|
Example
const decodedOperation = await checkUpdateTensorboardProgress(name); console.log(decodedOperation.result); console.log(decodedOperation.done); console.log(decodedOperation.metadata);
Terminate the gRPC channel and close the client.
The client will no longer be usable and all future behavior is undefined.
Returns
Type | Description |
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
Name | Description |
project |
string
|
location |
string
|
metadataStore |
string
|
context |
string
|
Returns
Type | Description |
string | {string} Resource name string.
|
createTensorboard(request?: protos.google.cloud.aiplatform.v1beta1.ICreateTensorboardRequest, options?: CallOptions): Promise<[
LROperation<protos.google.cloud.aiplatform.v1beta1.ITensorboard, protos.google.cloud.aiplatform.v1beta1.ICreateTensorboardOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]>;
Parameters
Name | Description |
request |
protos.google.cloud.aiplatform.v1beta1.ICreateTensorboardRequest
|
options |
CallOptions
|
Returns
Type | Description |
Promise<[
LROperation<protos.google.cloud.aiplatform.v1beta1.ITensorboard, protos.google.cloud.aiplatform.v1beta1.ICreateTensorboardOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]> | |
createTensorboard(request: protos.google.cloud.aiplatform.v1beta1.ICreateTensorboardRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.aiplatform.v1beta1.ITensorboard, protos.google.cloud.aiplatform.v1beta1.ICreateTensorboardOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.cloud.aiplatform.v1beta1.ICreateTensorboardRequest
|
options |
CallOptions
|
callback |
Callback<LROperation<protos.google.cloud.aiplatform.v1beta1.ITensorboard, protos.google.cloud.aiplatform.v1beta1.ICreateTensorboardOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
Returns
createTensorboard(request: protos.google.cloud.aiplatform.v1beta1.ICreateTensorboardRequest, callback: Callback<LROperation<protos.google.cloud.aiplatform.v1beta1.ITensorboard, protos.google.cloud.aiplatform.v1beta1.ICreateTensorboardOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.cloud.aiplatform.v1beta1.ICreateTensorboardRequest
|
callback |
Callback<LROperation<protos.google.cloud.aiplatform.v1beta1.ITensorboard, protos.google.cloud.aiplatform.v1beta1.ICreateTensorboardOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
Returns
createTensorboardExperiment(request?: protos.google.cloud.aiplatform.v1beta1.ICreateTensorboardExperimentRequest, options?: CallOptions): Promise<[
protos.google.cloud.aiplatform.v1beta1.ITensorboardExperiment,
(protos.google.cloud.aiplatform.v1beta1.ICreateTensorboardExperimentRequest | undefined),
{} | undefined
]>;
Parameters
Name | Description |
request |
protos.google.cloud.aiplatform.v1beta1.ICreateTensorboardExperimentRequest
|
options |
CallOptions
|
Returns
Type | Description |
Promise<[
protos.google.cloud.aiplatform.v1beta1.ITensorboardExperiment,
(protos.google.cloud.aiplatform.v1beta1.ICreateTensorboardExperimentRequest | undefined),
{} | undefined
]> | |
createTensorboardExperiment(request: protos.google.cloud.aiplatform.v1beta1.ICreateTensorboardExperimentRequest, options: CallOptions, callback: Callback<protos.google.cloud.aiplatform.v1beta1.ITensorboardExperiment, protos.google.cloud.aiplatform.v1beta1.ICreateTensorboardExperimentRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.cloud.aiplatform.v1beta1.ICreateTensorboardExperimentRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.cloud.aiplatform.v1beta1.ITensorboardExperiment, protos.google.cloud.aiplatform.v1beta1.ICreateTensorboardExperimentRequest | null | undefined, {} | null | undefined>
|
Returns
createTensorboardExperiment(request: protos.google.cloud.aiplatform.v1beta1.ICreateTensorboardExperimentRequest, callback: Callback<protos.google.cloud.aiplatform.v1beta1.ITensorboardExperiment, protos.google.cloud.aiplatform.v1beta1.ICreateTensorboardExperimentRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.cloud.aiplatform.v1beta1.ICreateTensorboardExperimentRequest
|
callback |
Callback<protos.google.cloud.aiplatform.v1beta1.ITensorboardExperiment, protos.google.cloud.aiplatform.v1beta1.ICreateTensorboardExperimentRequest | null | undefined, {} | null | undefined>
|
Returns
createTensorboardRun(request?: protos.google.cloud.aiplatform.v1beta1.ICreateTensorboardRunRequest, options?: CallOptions): Promise<[
protos.google.cloud.aiplatform.v1beta1.ITensorboardRun,
(protos.google.cloud.aiplatform.v1beta1.ICreateTensorboardRunRequest | undefined),
{} | undefined
]>;
Parameters
Name | Description |
request |
protos.google.cloud.aiplatform.v1beta1.ICreateTensorboardRunRequest
|
options |
CallOptions
|
Returns
Type | Description |
Promise<[
protos.google.cloud.aiplatform.v1beta1.ITensorboardRun,
(protos.google.cloud.aiplatform.v1beta1.ICreateTensorboardRunRequest | undefined),
{} | undefined
]> | |
createTensorboardRun(request: protos.google.cloud.aiplatform.v1beta1.ICreateTensorboardRunRequest, options: CallOptions, callback: Callback<protos.google.cloud.aiplatform.v1beta1.ITensorboardRun, protos.google.cloud.aiplatform.v1beta1.ICreateTensorboardRunRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.cloud.aiplatform.v1beta1.ICreateTensorboardRunRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.cloud.aiplatform.v1beta1.ITensorboardRun, protos.google.cloud.aiplatform.v1beta1.ICreateTensorboardRunRequest | null | undefined, {} | null | undefined>
|
Returns
createTensorboardRun(request: protos.google.cloud.aiplatform.v1beta1.ICreateTensorboardRunRequest, callback: Callback<protos.google.cloud.aiplatform.v1beta1.ITensorboardRun, protos.google.cloud.aiplatform.v1beta1.ICreateTensorboardRunRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.cloud.aiplatform.v1beta1.ICreateTensorboardRunRequest
|
callback |
Callback<protos.google.cloud.aiplatform.v1beta1.ITensorboardRun, protos.google.cloud.aiplatform.v1beta1.ICreateTensorboardRunRequest | null | undefined, {} | null | undefined>
|
Returns
createTensorboardTimeSeries(request?: protos.google.cloud.aiplatform.v1beta1.ICreateTensorboardTimeSeriesRequest, options?: CallOptions): Promise<[
protos.google.cloud.aiplatform.v1beta1.ITensorboardTimeSeries,
(protos.google.cloud.aiplatform.v1beta1.ICreateTensorboardTimeSeriesRequest | undefined),
{} | undefined
]>;
Parameters
Name | Description |
request |
protos.google.cloud.aiplatform.v1beta1.ICreateTensorboardTimeSeriesRequest
|
options |
CallOptions
|
Returns
Type | Description |
Promise<[
protos.google.cloud.aiplatform.v1beta1.ITensorboardTimeSeries,
(protos.google.cloud.aiplatform.v1beta1.ICreateTensorboardTimeSeriesRequest | undefined),
{} | undefined
]> | |
createTensorboardTimeSeries(request: protos.google.cloud.aiplatform.v1beta1.ICreateTensorboardTimeSeriesRequest, options: CallOptions, callback: Callback<protos.google.cloud.aiplatform.v1beta1.ITensorboardTimeSeries, protos.google.cloud.aiplatform.v1beta1.ICreateTensorboardTimeSeriesRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.cloud.aiplatform.v1beta1.ICreateTensorboardTimeSeriesRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.cloud.aiplatform.v1beta1.ITensorboardTimeSeries, protos.google.cloud.aiplatform.v1beta1.ICreateTensorboardTimeSeriesRequest | null | undefined, {} | null | undefined>
|
Returns
createTensorboardTimeSeries(request: protos.google.cloud.aiplatform.v1beta1.ICreateTensorboardTimeSeriesRequest, callback: Callback<protos.google.cloud.aiplatform.v1beta1.ITensorboardTimeSeries, protos.google.cloud.aiplatform.v1beta1.ICreateTensorboardTimeSeriesRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.cloud.aiplatform.v1beta1.ICreateTensorboardTimeSeriesRequest
|
callback |
Callback<protos.google.cloud.aiplatform.v1beta1.ITensorboardTimeSeries, protos.google.cloud.aiplatform.v1beta1.ICreateTensorboardTimeSeriesRequest | null | undefined, {} | null | undefined>
|
Returns
customJobPath(project: string, location: string, customJob: string): string;
Return a fully-qualified customJob resource name string.
Parameters
Name | Description |
project |
string
|
location |
string
|
customJob |
string
|
Returns
Type | Description |
string | {string} Resource name string.
|
dataItemPath(project: string, location: string, dataset: string, dataItem: string): string;
Return a fully-qualified dataItem resource name string.
Parameters
Name | Description |
project |
string
|
location |
string
|
dataset |
string
|
dataItem |
string
|
Returns
Type | Description |
string | {string} Resource name string.
|
dataLabelingJobPath(project: string, location: string, dataLabelingJob: string): string;
Return a fully-qualified dataLabelingJob resource name string.
Parameters
Name | Description |
project |
string
|
location |
string
|
dataLabelingJob |
string
|
Returns
Type | Description |
string | {string} Resource name string.
|
datasetPath(project: string, location: string, dataset: string): string;
Return a fully-qualified dataset resource name string.
Parameters
Name | Description |
project |
string
|
location |
string
|
dataset |
string
|
Returns
Type | Description |
string | {string} Resource name string.
|
deleteTensorboard(request?: protos.google.cloud.aiplatform.v1beta1.IDeleteTensorboardRequest, options?: CallOptions): Promise<[
LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.aiplatform.v1beta1.IDeleteOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]>;
Parameters
Name | Description |
request |
protos.google.cloud.aiplatform.v1beta1.IDeleteTensorboardRequest
|
options |
CallOptions
|
Returns
Type | Description |
Promise<[
LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.aiplatform.v1beta1.IDeleteOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]> | |
deleteTensorboard(request: protos.google.cloud.aiplatform.v1beta1.IDeleteTensorboardRequest, 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
Name | Description |
request |
protos.google.cloud.aiplatform.v1beta1.IDeleteTensorboardRequest
|
options |
CallOptions
|
callback |
Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.aiplatform.v1beta1.IDeleteOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
Returns
deleteTensorboard(request: protos.google.cloud.aiplatform.v1beta1.IDeleteTensorboardRequest, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.aiplatform.v1beta1.IDeleteOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.cloud.aiplatform.v1beta1.IDeleteTensorboardRequest
|
callback |
Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.aiplatform.v1beta1.IDeleteOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
Returns
deleteTensorboardExperiment(request?: protos.google.cloud.aiplatform.v1beta1.IDeleteTensorboardExperimentRequest, options?: CallOptions): Promise<[
LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.aiplatform.v1beta1.IDeleteOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]>;
Parameters
Name | Description |
request |
protos.google.cloud.aiplatform.v1beta1.IDeleteTensorboardExperimentRequest
|
options |
CallOptions
|
Returns
Type | Description |
Promise<[
LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.aiplatform.v1beta1.IDeleteOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]> | |
deleteTensorboardExperiment(request: protos.google.cloud.aiplatform.v1beta1.IDeleteTensorboardExperimentRequest, 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
Name | Description |
request |
protos.google.cloud.aiplatform.v1beta1.IDeleteTensorboardExperimentRequest
|
options |
CallOptions
|
callback |
Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.aiplatform.v1beta1.IDeleteOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
Returns
deleteTensorboardExperiment(request: protos.google.cloud.aiplatform.v1beta1.IDeleteTensorboardExperimentRequest, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.aiplatform.v1beta1.IDeleteOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.cloud.aiplatform.v1beta1.IDeleteTensorboardExperimentRequest
|
callback |
Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.aiplatform.v1beta1.IDeleteOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
Returns
deleteTensorboardRun(request?: protos.google.cloud.aiplatform.v1beta1.IDeleteTensorboardRunRequest, options?: CallOptions): Promise<[
LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.aiplatform.v1beta1.IDeleteOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]>;
Parameters
Name | Description |
request |
protos.google.cloud.aiplatform.v1beta1.IDeleteTensorboardRunRequest
|
options |
CallOptions
|
Returns
Type | Description |
Promise<[
LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.aiplatform.v1beta1.IDeleteOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]> | |
deleteTensorboardRun(request: protos.google.cloud.aiplatform.v1beta1.IDeleteTensorboardRunRequest, 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
Name | Description |
request |
protos.google.cloud.aiplatform.v1beta1.IDeleteTensorboardRunRequest
|
options |
CallOptions
|
callback |
Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.aiplatform.v1beta1.IDeleteOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
Returns
deleteTensorboardRun(request: protos.google.cloud.aiplatform.v1beta1.IDeleteTensorboardRunRequest, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.aiplatform.v1beta1.IDeleteOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.cloud.aiplatform.v1beta1.IDeleteTensorboardRunRequest
|
callback |
Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.aiplatform.v1beta1.IDeleteOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
Returns
deleteTensorboardTimeSeries(request?: protos.google.cloud.aiplatform.v1beta1.IDeleteTensorboardTimeSeriesRequest, options?: CallOptions): Promise<[
LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.aiplatform.v1beta1.IDeleteOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]>;
Parameters
Name | Description |
request |
protos.google.cloud.aiplatform.v1beta1.IDeleteTensorboardTimeSeriesRequest
|
options |
CallOptions
|
Returns
Type | Description |
Promise<[
LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.aiplatform.v1beta1.IDeleteOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]> | |
deleteTensorboardTimeSeries(request: protos.google.cloud.aiplatform.v1beta1.IDeleteTensorboardTimeSeriesRequest, 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
Name | Description |
request |
protos.google.cloud.aiplatform.v1beta1.IDeleteTensorboardTimeSeriesRequest
|
options |
CallOptions
|
callback |
Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.aiplatform.v1beta1.IDeleteOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
Returns
deleteTensorboardTimeSeries(request: protos.google.cloud.aiplatform.v1beta1.IDeleteTensorboardTimeSeriesRequest, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.aiplatform.v1beta1.IDeleteOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.cloud.aiplatform.v1beta1.IDeleteTensorboardTimeSeriesRequest
|
callback |
Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.aiplatform.v1beta1.IDeleteOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
Returns
endpointPath(project: string, location: string, endpoint: string): string;
Return a fully-qualified endpoint resource name string.
Parameters
Name | Description |
project |
string
|
location |
string
|
endpoint |
string
|
Returns
Type | Description |
string | {string} Resource name string.
|
entityTypePath(project: string, location: string, featurestore: string, entityType: string): string;
Return a fully-qualified entityType resource name string.
Parameters
Name | Description |
project |
string
|
location |
string
|
featurestore |
string
|
entityType |
string
|
Returns
Type | Description |
string | {string} Resource name string.
|
executionPath(project: string, location: string, metadataStore: string, execution: string): string;
Return a fully-qualified execution resource name string.
Parameters
Name | Description |
project |
string
|
location |
string
|
metadataStore |
string
|
execution |
string
|
Returns
Type | Description |
string | {string} Resource name string.
|
exportTensorboardTimeSeriesData(request?: protos.google.cloud.aiplatform.v1beta1.IExportTensorboardTimeSeriesDataRequest, options?: CallOptions): Promise<[
protos.google.cloud.aiplatform.v1beta1.ITimeSeriesDataPoint[],
protos.google.cloud.aiplatform.v1beta1.IExportTensorboardTimeSeriesDataRequest | null,
protos.google.cloud.aiplatform.v1beta1.IExportTensorboardTimeSeriesDataResponse
]>;
Parameters
Name | Description |
request |
protos.google.cloud.aiplatform.v1beta1.IExportTensorboardTimeSeriesDataRequest
|
options |
CallOptions
|
Returns
Type | Description |
Promise<[
protos.google.cloud.aiplatform.v1beta1.ITimeSeriesDataPoint[],
protos.google.cloud.aiplatform.v1beta1.IExportTensorboardTimeSeriesDataRequest | null,
protos.google.cloud.aiplatform.v1beta1.IExportTensorboardTimeSeriesDataResponse
]> | |
exportTensorboardTimeSeriesData(request: protos.google.cloud.aiplatform.v1beta1.IExportTensorboardTimeSeriesDataRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.aiplatform.v1beta1.IExportTensorboardTimeSeriesDataRequest, protos.google.cloud.aiplatform.v1beta1.IExportTensorboardTimeSeriesDataResponse | null | undefined, protos.google.cloud.aiplatform.v1beta1.ITimeSeriesDataPoint>): void;
Parameters
Name | Description |
request |
protos.google.cloud.aiplatform.v1beta1.IExportTensorboardTimeSeriesDataRequest
|
options |
CallOptions
|
callback |
PaginationCallback<protos.google.cloud.aiplatform.v1beta1.IExportTensorboardTimeSeriesDataRequest, protos.google.cloud.aiplatform.v1beta1.IExportTensorboardTimeSeriesDataResponse | null | undefined, protos.google.cloud.aiplatform.v1beta1.ITimeSeriesDataPoint>
|
Returns
exportTensorboardTimeSeriesData(request: protos.google.cloud.aiplatform.v1beta1.IExportTensorboardTimeSeriesDataRequest, callback: PaginationCallback<protos.google.cloud.aiplatform.v1beta1.IExportTensorboardTimeSeriesDataRequest, protos.google.cloud.aiplatform.v1beta1.IExportTensorboardTimeSeriesDataResponse | null | undefined, protos.google.cloud.aiplatform.v1beta1.ITimeSeriesDataPoint>): void;
Parameters
Name | Description |
request |
protos.google.cloud.aiplatform.v1beta1.IExportTensorboardTimeSeriesDataRequest
|
callback |
PaginationCallback<protos.google.cloud.aiplatform.v1beta1.IExportTensorboardTimeSeriesDataRequest, protos.google.cloud.aiplatform.v1beta1.IExportTensorboardTimeSeriesDataResponse | null | undefined, protos.google.cloud.aiplatform.v1beta1.ITimeSeriesDataPoint>
|
Returns
exportTensorboardTimeSeriesDataAsync(request?: protos.google.cloud.aiplatform.v1beta1.IExportTensorboardTimeSeriesDataRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.aiplatform.v1beta1.ITimeSeriesDataPoint>;
Equivalent to exportTensorboardTimeSeriesData
, but returns an iterable object.
for
-await
-of
syntax is used with the iterable to get response elements on-demand.
Parameters
Name | Description |
request |
protos.google.cloud.aiplatform.v1beta1.IExportTensorboardTimeSeriesDataRequest
The request object that will be sent.
|
options |
CallOptions
Call options. See CallOptions for more details.
|
Returns
Type | Description |
AsyncIterable<protos.google.cloud.aiplatform.v1beta1.ITimeSeriesDataPoint> | {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 [TimeSeriesDataPoint]. 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.
|
Example
const iterable = client.exportTensorboardTimeSeriesDataAsync(request); for await (const response of iterable) { // process response }
exportTensorboardTimeSeriesDataStream(request?: protos.google.cloud.aiplatform.v1beta1.IExportTensorboardTimeSeriesDataRequest, options?: CallOptions): Transform;
Equivalent to method.name.toCamelCase()
, but returns a NodeJS Stream object.
Parameters
Name | Description |
request |
protos.google.cloud.aiplatform.v1beta1.IExportTensorboardTimeSeriesDataRequest
The request object that will be sent.
|
options |
CallOptions
Call options. See CallOptions for more details.
|
Returns
Type | Description |
Transform | {Stream} An object stream which emits an object representing [TimeSeriesDataPoint] 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 exportTensorboardTimeSeriesDataAsync() 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.
|
featurePath(project: string, location: string, featurestore: string, entityType: string, feature: string): string;
Return a fully-qualified feature resource name string.
Parameters
Name | Description |
project |
string
|
location |
string
|
featurestore |
string
|
entityType |
string
|
feature |
string
|
Returns
Type | Description |
string | {string} Resource name string.
|
featurestorePath(project: string, location: string, featurestore: string): string;
Return a fully-qualified featurestore resource name string.
Parameters
Name | Description |
project |
string
|
location |
string
|
featurestore |
string
|
Returns
Type | Description |
string | {string} Resource name string.
|
getProjectId(): Promise<string>;
Returns
Type | Description |
Promise<string> | |
getProjectId(callback: Callback<string, undefined, undefined>): void;
Parameter
Name | Description |
callback |
Callback<string, undefined, undefined>
|
Returns
getTensorboard(request?: protos.google.cloud.aiplatform.v1beta1.IGetTensorboardRequest, options?: CallOptions): Promise<[
protos.google.cloud.aiplatform.v1beta1.ITensorboard,
protos.google.cloud.aiplatform.v1beta1.IGetTensorboardRequest | undefined,
{} | undefined
]>;
Parameters
Name | Description |
request |
protos.google.cloud.aiplatform.v1beta1.IGetTensorboardRequest
|
options |
CallOptions
|
Returns
Type | Description |
Promise<[
protos.google.cloud.aiplatform.v1beta1.ITensorboard,
protos.google.cloud.aiplatform.v1beta1.IGetTensorboardRequest | undefined,
{} | undefined
]> | |
getTensorboard(request: protos.google.cloud.aiplatform.v1beta1.IGetTensorboardRequest, options: CallOptions, callback: Callback<protos.google.cloud.aiplatform.v1beta1.ITensorboard, protos.google.cloud.aiplatform.v1beta1.IGetTensorboardRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.cloud.aiplatform.v1beta1.IGetTensorboardRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.cloud.aiplatform.v1beta1.ITensorboard, protos.google.cloud.aiplatform.v1beta1.IGetTensorboardRequest | null | undefined, {} | null | undefined>
|
Returns
getTensorboard(request: protos.google.cloud.aiplatform.v1beta1.IGetTensorboardRequest, callback: Callback<protos.google.cloud.aiplatform.v1beta1.ITensorboard, protos.google.cloud.aiplatform.v1beta1.IGetTensorboardRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.cloud.aiplatform.v1beta1.IGetTensorboardRequest
|
callback |
Callback<protos.google.cloud.aiplatform.v1beta1.ITensorboard, protos.google.cloud.aiplatform.v1beta1.IGetTensorboardRequest | null | undefined, {} | null | undefined>
|
Returns
getTensorboardExperiment(request?: protos.google.cloud.aiplatform.v1beta1.IGetTensorboardExperimentRequest, options?: CallOptions): Promise<[
protos.google.cloud.aiplatform.v1beta1.ITensorboardExperiment,
(protos.google.cloud.aiplatform.v1beta1.IGetTensorboardExperimentRequest | undefined),
{} | undefined
]>;
Parameters
Name | Description |
request |
protos.google.cloud.aiplatform.v1beta1.IGetTensorboardExperimentRequest
|
options |
CallOptions
|
Returns
Type | Description |
Promise<[
protos.google.cloud.aiplatform.v1beta1.ITensorboardExperiment,
(protos.google.cloud.aiplatform.v1beta1.IGetTensorboardExperimentRequest | undefined),
{} | undefined
]> | |
getTensorboardExperiment(request: protos.google.cloud.aiplatform.v1beta1.IGetTensorboardExperimentRequest, options: CallOptions, callback: Callback<protos.google.cloud.aiplatform.v1beta1.ITensorboardExperiment, protos.google.cloud.aiplatform.v1beta1.IGetTensorboardExperimentRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.cloud.aiplatform.v1beta1.IGetTensorboardExperimentRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.cloud.aiplatform.v1beta1.ITensorboardExperiment, protos.google.cloud.aiplatform.v1beta1.IGetTensorboardExperimentRequest | null | undefined, {} | null | undefined>
|
Returns
getTensorboardExperiment(request: protos.google.cloud.aiplatform.v1beta1.IGetTensorboardExperimentRequest, callback: Callback<protos.google.cloud.aiplatform.v1beta1.ITensorboardExperiment, protos.google.cloud.aiplatform.v1beta1.IGetTensorboardExperimentRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.cloud.aiplatform.v1beta1.IGetTensorboardExperimentRequest
|
callback |
Callback<protos.google.cloud.aiplatform.v1beta1.ITensorboardExperiment, protos.google.cloud.aiplatform.v1beta1.IGetTensorboardExperimentRequest | null | undefined, {} | null | undefined>
|
Returns
getTensorboardRun(request?: protos.google.cloud.aiplatform.v1beta1.IGetTensorboardRunRequest, options?: CallOptions): Promise<[
protos.google.cloud.aiplatform.v1beta1.ITensorboardRun,
(protos.google.cloud.aiplatform.v1beta1.IGetTensorboardRunRequest | undefined),
{} | undefined
]>;
Parameters
Name | Description |
request |
protos.google.cloud.aiplatform.v1beta1.IGetTensorboardRunRequest
|
options |
CallOptions
|
Returns
Type | Description |
Promise<[
protos.google.cloud.aiplatform.v1beta1.ITensorboardRun,
(protos.google.cloud.aiplatform.v1beta1.IGetTensorboardRunRequest | undefined),
{} | undefined
]> | |
getTensorboardRun(request: protos.google.cloud.aiplatform.v1beta1.IGetTensorboardRunRequest, options: CallOptions, callback: Callback<protos.google.cloud.aiplatform.v1beta1.ITensorboardRun, protos.google.cloud.aiplatform.v1beta1.IGetTensorboardRunRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.cloud.aiplatform.v1beta1.IGetTensorboardRunRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.cloud.aiplatform.v1beta1.ITensorboardRun, protos.google.cloud.aiplatform.v1beta1.IGetTensorboardRunRequest | null | undefined, {} | null | undefined>
|
Returns
getTensorboardRun(request: protos.google.cloud.aiplatform.v1beta1.IGetTensorboardRunRequest, callback: Callback<protos.google.cloud.aiplatform.v1beta1.ITensorboardRun, protos.google.cloud.aiplatform.v1beta1.IGetTensorboardRunRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.cloud.aiplatform.v1beta1.IGetTensorboardRunRequest
|
callback |
Callback<protos.google.cloud.aiplatform.v1beta1.ITensorboardRun, protos.google.cloud.aiplatform.v1beta1.IGetTensorboardRunRequest | null | undefined, {} | null | undefined>
|
Returns
getTensorboardTimeSeries(request?: protos.google.cloud.aiplatform.v1beta1.IGetTensorboardTimeSeriesRequest, options?: CallOptions): Promise<[
protos.google.cloud.aiplatform.v1beta1.ITensorboardTimeSeries,
(protos.google.cloud.aiplatform.v1beta1.IGetTensorboardTimeSeriesRequest | undefined),
{} | undefined
]>;
Parameters
Name | Description |
request |
protos.google.cloud.aiplatform.v1beta1.IGetTensorboardTimeSeriesRequest
|
options |
CallOptions
|
Returns
Type | Description |
Promise<[
protos.google.cloud.aiplatform.v1beta1.ITensorboardTimeSeries,
(protos.google.cloud.aiplatform.v1beta1.IGetTensorboardTimeSeriesRequest | undefined),
{} | undefined
]> | |
getTensorboardTimeSeries(request: protos.google.cloud.aiplatform.v1beta1.IGetTensorboardTimeSeriesRequest, options: CallOptions, callback: Callback<protos.google.cloud.aiplatform.v1beta1.ITensorboardTimeSeries, protos.google.cloud.aiplatform.v1beta1.IGetTensorboardTimeSeriesRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.cloud.aiplatform.v1beta1.IGetTensorboardTimeSeriesRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.cloud.aiplatform.v1beta1.ITensorboardTimeSeries, protos.google.cloud.aiplatform.v1beta1.IGetTensorboardTimeSeriesRequest | null | undefined, {} | null | undefined>
|
Returns
getTensorboardTimeSeries(request: protos.google.cloud.aiplatform.v1beta1.IGetTensorboardTimeSeriesRequest, callback: Callback<protos.google.cloud.aiplatform.v1beta1.ITensorboardTimeSeries, protos.google.cloud.aiplatform.v1beta1.IGetTensorboardTimeSeriesRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.cloud.aiplatform.v1beta1.IGetTensorboardTimeSeriesRequest
|
callback |
Callback<protos.google.cloud.aiplatform.v1beta1.ITensorboardTimeSeries, protos.google.cloud.aiplatform.v1beta1.IGetTensorboardTimeSeriesRequest | null | undefined, {} | null | undefined>
|
Returns
hyperparameterTuningJobPath(project: string, location: string, hyperparameterTuningJob: string): string;
Return a fully-qualified hyperparameterTuningJob resource name string.
Parameters
Name | Description |
project |
string
|
location |
string
|
hyperparameterTuningJob |
string
|
Returns
Type | Description |
string | {string} Resource name string.
|
indexEndpointPath(project: string, location: string, indexEndpoint: string): string;
Return a fully-qualified indexEndpoint resource name string.
Parameters
Name | Description |
project |
string
|
location |
string
|
indexEndpoint |
string
|
Returns
Type | Description |
string | {string} Resource name string.
|
indexPath(project: string, location: string, index: string): string;
Return a fully-qualified index resource name string.
Parameters
Name | Description |
project |
string
|
location |
string
|
index |
string
|
Returns
Type | Description |
string | {string} Resource name string.
|
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
Type | Description |
Promise<{
[name: string]: Function;
}> | {Promise} A promise that resolves to an authenticated service stub.
|
listTensorboardExperiments(request?: protos.google.cloud.aiplatform.v1beta1.IListTensorboardExperimentsRequest, options?: CallOptions): Promise<[
protos.google.cloud.aiplatform.v1beta1.ITensorboardExperiment[],
protos.google.cloud.aiplatform.v1beta1.IListTensorboardExperimentsRequest | null,
protos.google.cloud.aiplatform.v1beta1.IListTensorboardExperimentsResponse
]>;
Parameters
Name | Description |
request |
protos.google.cloud.aiplatform.v1beta1.IListTensorboardExperimentsRequest
|
options |
CallOptions
|
Returns
Type | Description |
Promise<[
protos.google.cloud.aiplatform.v1beta1.ITensorboardExperiment[],
protos.google.cloud.aiplatform.v1beta1.IListTensorboardExperimentsRequest | null,
protos.google.cloud.aiplatform.v1beta1.IListTensorboardExperimentsResponse
]> | |
listTensorboardExperiments(request: protos.google.cloud.aiplatform.v1beta1.IListTensorboardExperimentsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.aiplatform.v1beta1.IListTensorboardExperimentsRequest, protos.google.cloud.aiplatform.v1beta1.IListTensorboardExperimentsResponse | null | undefined, protos.google.cloud.aiplatform.v1beta1.ITensorboardExperiment>): void;
Parameters
Name | Description |
request |
protos.google.cloud.aiplatform.v1beta1.IListTensorboardExperimentsRequest
|
options |
CallOptions
|
callback |
PaginationCallback<protos.google.cloud.aiplatform.v1beta1.IListTensorboardExperimentsRequest, protos.google.cloud.aiplatform.v1beta1.IListTensorboardExperimentsResponse | null | undefined, protos.google.cloud.aiplatform.v1beta1.ITensorboardExperiment>
|
Returns
listTensorboardExperiments(request: protos.google.cloud.aiplatform.v1beta1.IListTensorboardExperimentsRequest, callback: PaginationCallback<protos.google.cloud.aiplatform.v1beta1.IListTensorboardExperimentsRequest, protos.google.cloud.aiplatform.v1beta1.IListTensorboardExperimentsResponse | null | undefined, protos.google.cloud.aiplatform.v1beta1.ITensorboardExperiment>): void;
Parameters
Name | Description |
request |
protos.google.cloud.aiplatform.v1beta1.IListTensorboardExperimentsRequest
|
callback |
PaginationCallback<protos.google.cloud.aiplatform.v1beta1.IListTensorboardExperimentsRequest, protos.google.cloud.aiplatform.v1beta1.IListTensorboardExperimentsResponse | null | undefined, protos.google.cloud.aiplatform.v1beta1.ITensorboardExperiment>
|
Returns
listTensorboardExperimentsAsync(request?: protos.google.cloud.aiplatform.v1beta1.IListTensorboardExperimentsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.aiplatform.v1beta1.ITensorboardExperiment>;
Equivalent to listTensorboardExperiments
, but returns an iterable object.
for
-await
-of
syntax is used with the iterable to get response elements on-demand.
Parameters
Name | Description |
request |
protos.google.cloud.aiplatform.v1beta1.IListTensorboardExperimentsRequest
The request object that will be sent.
|
options |
CallOptions
Call options. See CallOptions for more details.
|
Returns
Type | Description |
AsyncIterable<protos.google.cloud.aiplatform.v1beta1.ITensorboardExperiment> | {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 [TensorboardExperiment]. 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.
|
Example
const iterable = client.listTensorboardExperimentsAsync(request); for await (const response of iterable) { // process response }
listTensorboardExperimentsStream(request?: protos.google.cloud.aiplatform.v1beta1.IListTensorboardExperimentsRequest, options?: CallOptions): Transform;
Equivalent to method.name.toCamelCase()
, but returns a NodeJS Stream object.
Parameters
Name | Description |
request |
protos.google.cloud.aiplatform.v1beta1.IListTensorboardExperimentsRequest
The request object that will be sent.
|
options |
CallOptions
Call options. See CallOptions for more details.
|
Returns
Type | Description |
Transform | {Stream} An object stream which emits an object representing [TensorboardExperiment] 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 listTensorboardExperimentsAsync() 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.
|
listTensorboardRuns(request?: protos.google.cloud.aiplatform.v1beta1.IListTensorboardRunsRequest, options?: CallOptions): Promise<[
protos.google.cloud.aiplatform.v1beta1.ITensorboardRun[],
protos.google.cloud.aiplatform.v1beta1.IListTensorboardRunsRequest | null,
protos.google.cloud.aiplatform.v1beta1.IListTensorboardRunsResponse
]>;
Parameters
Name | Description |
request |
protos.google.cloud.aiplatform.v1beta1.IListTensorboardRunsRequest
|
options |
CallOptions
|
Returns
Type | Description |
Promise<[
protos.google.cloud.aiplatform.v1beta1.ITensorboardRun[],
protos.google.cloud.aiplatform.v1beta1.IListTensorboardRunsRequest | null,
protos.google.cloud.aiplatform.v1beta1.IListTensorboardRunsResponse
]> | |
listTensorboardRuns(request: protos.google.cloud.aiplatform.v1beta1.IListTensorboardRunsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.aiplatform.v1beta1.IListTensorboardRunsRequest, protos.google.cloud.aiplatform.v1beta1.IListTensorboardRunsResponse | null | undefined, protos.google.cloud.aiplatform.v1beta1.ITensorboardRun>): void;
Parameters
Name | Description |
request |
protos.google.cloud.aiplatform.v1beta1.IListTensorboardRunsRequest
|
options |
CallOptions
|
callback |
PaginationCallback<protos.google.cloud.aiplatform.v1beta1.IListTensorboardRunsRequest, protos.google.cloud.aiplatform.v1beta1.IListTensorboardRunsResponse | null | undefined, protos.google.cloud.aiplatform.v1beta1.ITensorboardRun>
|
Returns
listTensorboardRuns(request: protos.google.cloud.aiplatform.v1beta1.IListTensorboardRunsRequest, callback: PaginationCallback<protos.google.cloud.aiplatform.v1beta1.IListTensorboardRunsRequest, protos.google.cloud.aiplatform.v1beta1.IListTensorboardRunsResponse | null | undefined, protos.google.cloud.aiplatform.v1beta1.ITensorboardRun>): void;
Parameters
Name | Description |
request |
protos.google.cloud.aiplatform.v1beta1.IListTensorboardRunsRequest
|
callback |
PaginationCallback<protos.google.cloud.aiplatform.v1beta1.IListTensorboardRunsRequest, protos.google.cloud.aiplatform.v1beta1.IListTensorboardRunsResponse | null | undefined, protos.google.cloud.aiplatform.v1beta1.ITensorboardRun>
|
Returns
listTensorboardRunsAsync(request?: protos.google.cloud.aiplatform.v1beta1.IListTensorboardRunsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.aiplatform.v1beta1.ITensorboardRun>;
Equivalent to listTensorboardRuns
, but returns an iterable object.
for
-await
-of
syntax is used with the iterable to get response elements on-demand.
Parameters
Name | Description |
request |
protos.google.cloud.aiplatform.v1beta1.IListTensorboardRunsRequest
The request object that will be sent.
|
options |
CallOptions
Call options. See CallOptions for more details.
|
Returns
Type | Description |
AsyncIterable<protos.google.cloud.aiplatform.v1beta1.ITensorboardRun> | {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 [TensorboardRun]. 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.
|
Example
const iterable = client.listTensorboardRunsAsync(request); for await (const response of iterable) { // process response }
listTensorboardRunsStream(request?: protos.google.cloud.aiplatform.v1beta1.IListTensorboardRunsRequest, options?: CallOptions): Transform;
Equivalent to method.name.toCamelCase()
, but returns a NodeJS Stream object.
Parameters
Name | Description |
request |
protos.google.cloud.aiplatform.v1beta1.IListTensorboardRunsRequest
The request object that will be sent.
|
options |
CallOptions
Call options. See CallOptions for more details.
|
Returns
Type | Description |
Transform | {Stream} An object stream which emits an object representing [TensorboardRun] 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 listTensorboardRunsAsync() 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.
|
listTensorboards(request?: protos.google.cloud.aiplatform.v1beta1.IListTensorboardsRequest, options?: CallOptions): Promise<[
protos.google.cloud.aiplatform.v1beta1.ITensorboard[],
protos.google.cloud.aiplatform.v1beta1.IListTensorboardsRequest | null,
protos.google.cloud.aiplatform.v1beta1.IListTensorboardsResponse
]>;
Parameters
Name | Description |
request |
protos.google.cloud.aiplatform.v1beta1.IListTensorboardsRequest
|
options |
CallOptions
|
Returns
Type | Description |
Promise<[
protos.google.cloud.aiplatform.v1beta1.ITensorboard[],
protos.google.cloud.aiplatform.v1beta1.IListTensorboardsRequest | null,
protos.google.cloud.aiplatform.v1beta1.IListTensorboardsResponse
]> | |
listTensorboards(request: protos.google.cloud.aiplatform.v1beta1.IListTensorboardsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.aiplatform.v1beta1.IListTensorboardsRequest, protos.google.cloud.aiplatform.v1beta1.IListTensorboardsResponse | null | undefined, protos.google.cloud.aiplatform.v1beta1.ITensorboard>): void;
Parameters
Name | Description |
request |
protos.google.cloud.aiplatform.v1beta1.IListTensorboardsRequest
|
options |
CallOptions
|
callback |
PaginationCallback<protos.google.cloud.aiplatform.v1beta1.IListTensorboardsRequest, protos.google.cloud.aiplatform.v1beta1.IListTensorboardsResponse | null | undefined, protos.google.cloud.aiplatform.v1beta1.ITensorboard>
|
Returns
listTensorboards(request: protos.google.cloud.aiplatform.v1beta1.IListTensorboardsRequest, callback: PaginationCallback<protos.google.cloud.aiplatform.v1beta1.IListTensorboardsRequest, protos.google.cloud.aiplatform.v1beta1.IListTensorboardsResponse | null | undefined, protos.google.cloud.aiplatform.v1beta1.ITensorboard>): void;
Parameters
Name | Description |
request |
protos.google.cloud.aiplatform.v1beta1.IListTensorboardsRequest
|
callback |
PaginationCallback<protos.google.cloud.aiplatform.v1beta1.IListTensorboardsRequest, protos.google.cloud.aiplatform.v1beta1.IListTensorboardsResponse | null | undefined, protos.google.cloud.aiplatform.v1beta1.ITensorboard>
|
Returns
listTensorboardsAsync(request?: protos.google.cloud.aiplatform.v1beta1.IListTensorboardsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.aiplatform.v1beta1.ITensorboard>;
Equivalent to listTensorboards
, but returns an iterable object.
for
-await
-of
syntax is used with the iterable to get response elements on-demand.
Parameters
Name | Description |
request |
protos.google.cloud.aiplatform.v1beta1.IListTensorboardsRequest
The request object that will be sent.
|
options |
CallOptions
Call options. See CallOptions for more details.
|
Returns
Type | Description |
AsyncIterable<protos.google.cloud.aiplatform.v1beta1.ITensorboard> | {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 [Tensorboard]. 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.
|
Example
const iterable = client.listTensorboardsAsync(request); for await (const response of iterable) { // process response }
listTensorboardsStream(request?: protos.google.cloud.aiplatform.v1beta1.IListTensorboardsRequest, options?: CallOptions): Transform;
Equivalent to method.name.toCamelCase()
, but returns a NodeJS Stream object.
Parameters
Name | Description |
request |
protos.google.cloud.aiplatform.v1beta1.IListTensorboardsRequest
The request object that will be sent.
|
options |
CallOptions
Call options. See CallOptions for more details.
|
Returns
Type | Description |
Transform | {Stream} An object stream which emits an object representing [Tensorboard] 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 listTensorboardsAsync() 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.
|
listTensorboardTimeSeries(request?: protos.google.cloud.aiplatform.v1beta1.IListTensorboardTimeSeriesRequest, options?: CallOptions): Promise<[
protos.google.cloud.aiplatform.v1beta1.ITensorboardTimeSeries[],
protos.google.cloud.aiplatform.v1beta1.IListTensorboardTimeSeriesRequest | null,
protos.google.cloud.aiplatform.v1beta1.IListTensorboardTimeSeriesResponse
]>;
Parameters
Name | Description |
request |
protos.google.cloud.aiplatform.v1beta1.IListTensorboardTimeSeriesRequest
|
options |
CallOptions
|
Returns
Type | Description |
Promise<[
protos.google.cloud.aiplatform.v1beta1.ITensorboardTimeSeries[],
protos.google.cloud.aiplatform.v1beta1.IListTensorboardTimeSeriesRequest | null,
protos.google.cloud.aiplatform.v1beta1.IListTensorboardTimeSeriesResponse
]> | |
listTensorboardTimeSeries(request: protos.google.cloud.aiplatform.v1beta1.IListTensorboardTimeSeriesRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.aiplatform.v1beta1.IListTensorboardTimeSeriesRequest, protos.google.cloud.aiplatform.v1beta1.IListTensorboardTimeSeriesResponse | null | undefined, protos.google.cloud.aiplatform.v1beta1.ITensorboardTimeSeries>): void;
Parameters
Name | Description |
request |
protos.google.cloud.aiplatform.v1beta1.IListTensorboardTimeSeriesRequest
|
options |
CallOptions
|
callback |
PaginationCallback<protos.google.cloud.aiplatform.v1beta1.IListTensorboardTimeSeriesRequest, protos.google.cloud.aiplatform.v1beta1.IListTensorboardTimeSeriesResponse | null | undefined, protos.google.cloud.aiplatform.v1beta1.ITensorboardTimeSeries>
|
Returns
listTensorboardTimeSeries(request: protos.google.cloud.aiplatform.v1beta1.IListTensorboardTimeSeriesRequest, callback: PaginationCallback<protos.google.cloud.aiplatform.v1beta1.IListTensorboardTimeSeriesRequest, protos.google.cloud.aiplatform.v1beta1.IListTensorboardTimeSeriesResponse | null | undefined, protos.google.cloud.aiplatform.v1beta1.ITensorboardTimeSeries>): void;
Parameters
Name | Description |
request |
protos.google.cloud.aiplatform.v1beta1.IListTensorboardTimeSeriesRequest
|
callback |
PaginationCallback<protos.google.cloud.aiplatform.v1beta1.IListTensorboardTimeSeriesRequest, protos.google.cloud.aiplatform.v1beta1.IListTensorboardTimeSeriesResponse | null | undefined, protos.google.cloud.aiplatform.v1beta1.ITensorboardTimeSeries>
|
Returns
listTensorboardTimeSeriesAsync(request?: protos.google.cloud.aiplatform.v1beta1.IListTensorboardTimeSeriesRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.aiplatform.v1beta1.ITensorboardTimeSeries>;
Equivalent to listTensorboardTimeSeries
, but returns an iterable object.
for
-await
-of
syntax is used with the iterable to get response elements on-demand.
Parameters
Name | Description |
request |
protos.google.cloud.aiplatform.v1beta1.IListTensorboardTimeSeriesRequest
The request object that will be sent.
|
options |
CallOptions
Call options. See CallOptions for more details.
|
Returns
Type | Description |
AsyncIterable<protos.google.cloud.aiplatform.v1beta1.ITensorboardTimeSeries> | {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 [TensorboardTimeSeries]. 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.
|
Example
const iterable = client.listTensorboardTimeSeriesAsync(request); for await (const response of iterable) { // process response }
listTensorboardTimeSeriesStream(request?: protos.google.cloud.aiplatform.v1beta1.IListTensorboardTimeSeriesRequest, options?: CallOptions): Transform;
Equivalent to method.name.toCamelCase()
, but returns a NodeJS Stream object.
Parameters
Name | Description |
request |
protos.google.cloud.aiplatform.v1beta1.IListTensorboardTimeSeriesRequest
The request object that will be sent.
|
options |
CallOptions
Call options. See CallOptions for more details.
|
Returns
Type | Description |
Transform | {Stream} An object stream which emits an object representing [TensorboardTimeSeries] 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 listTensorboardTimeSeriesAsync() 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: string, location: string): string;
Return a fully-qualified location resource name string.
Parameters
Name | Description |
project |
string
|
location |
string
|
Returns
Type | Description |
string | {string} Resource name string.
|
matchAnnotationFromAnnotationName(annotationName: string): string | number;
Parse the annotation from Annotation resource.
Parameter
Name | Description |
annotationName |
string
A fully-qualified path representing Annotation resource.
|
Returns
Type | Description |
string | number | {string} A string representing the annotation.
|
matchAnnotationSpecFromAnnotationSpecName(annotationSpecName: string): string | number;
Parse the annotation_spec from AnnotationSpec resource.
Parameter
Name | Description |
annotationSpecName |
string
A fully-qualified path representing AnnotationSpec resource.
|
Returns
Type | Description |
string | number | {string} A string representing the annotation_spec.
|
matchArtifactFromArtifactName(artifactName: string): string | number;
Parse the artifact from Artifact resource.
Parameter
Name | Description |
artifactName |
string
A fully-qualified path representing Artifact resource.
|
Returns
Type | Description |
string | number | {string} A string representing the artifact.
|
matchBatchPredictionJobFromBatchPredictionJobName(batchPredictionJobName: string): string | number;
Parse the batch_prediction_job from BatchPredictionJob resource.
Parameter
Name | Description |
batchPredictionJobName |
string
A fully-qualified path representing BatchPredictionJob resource.
|
Returns
Type | Description |
string | number | {string} A string representing the batch_prediction_job.
|
matchContextFromContextName(contextName)
matchContextFromContextName(contextName: string): string | number;
Parse the context from Context resource.
Parameter
Name | Description |
contextName |
string
A fully-qualified path representing Context resource.
|
Returns
Type | Description |
string | number | {string} A string representing the context.
|
matchCustomJobFromCustomJobName(customJobName: string): string | number;
Parse the custom_job from CustomJob resource.
Parameter
Name | Description |
customJobName |
string
A fully-qualified path representing CustomJob resource.
|
Returns
Type | Description |
string | number | {string} A string representing the custom_job.
|
matchDataItemFromAnnotationName(annotationName: string): string | number;
Parse the data_item from Annotation resource.
Parameter
Name | Description |
annotationName |
string
A fully-qualified path representing Annotation resource.
|
Returns
Type | Description |
string | number | {string} A string representing the data_item.
|
matchDataItemFromDataItemName(dataItemName: string): string | number;
Parse the data_item from DataItem resource.
Parameter
Name | Description |
dataItemName |
string
A fully-qualified path representing DataItem resource.
|
Returns
Type | Description |
string | number | {string} A string representing the data_item.
|
matchDataLabelingJobFromDataLabelingJobName(dataLabelingJobName: string): string | number;
Parse the data_labeling_job from DataLabelingJob resource.
Parameter
Name | Description |
dataLabelingJobName |
string
A fully-qualified path representing DataLabelingJob resource.
|
Returns
Type | Description |
string | number | {string} A string representing the data_labeling_job.
|
matchDatasetFromAnnotationName(annotationName: string): string | number;
Parse the dataset from Annotation resource.
Parameter
Name | Description |
annotationName |
string
A fully-qualified path representing Annotation resource.
|
Returns
Type | Description |
string | number | {string} A string representing the dataset.
|
matchDatasetFromAnnotationSpecName(annotationSpecName: string): string | number;
Parse the dataset from AnnotationSpec resource.
Parameter
Name | Description |
annotationSpecName |
string
A fully-qualified path representing AnnotationSpec resource.
|
Returns
Type | Description |
string | number | {string} A string representing the dataset.
|
matchDatasetFromDataItemName(dataItemName: string): string | number;
Parse the dataset from DataItem resource.
Parameter
Name | Description |
dataItemName |
string
A fully-qualified path representing DataItem resource.
|
Returns
Type | Description |
string | number | {string} A string representing the dataset.
|
matchDatasetFromDatasetName(datasetName: string): string | number;
Parse the dataset from Dataset resource.
Parameter
Name | Description |
datasetName |
string
A fully-qualified path representing Dataset resource.
|
Returns
Type | Description |
string | number | {string} A string representing the dataset.
|
matchEndpointFromEndpointName(endpointName: string): string | number;
Parse the endpoint from Endpoint resource.
Parameter
Name | Description |
endpointName |
string
A fully-qualified path representing Endpoint resource.
|
Returns
Type | Description |
string | number | {string} A string representing the endpoint.
|
matchEntityTypeFromEntityTypeName(entityTypeName: string): string | number;
Parse the entity_type from EntityType resource.
Parameter
Name | Description |
entityTypeName |
string
A fully-qualified path representing EntityType resource.
|
Returns
Type | Description |
string | number | {string} A string representing the entity_type.
|
matchEntityTypeFromFeatureName(featureName: string): string | number;
Parse the entity_type from Feature resource.
Parameter
Name | Description |
featureName |
string
A fully-qualified path representing Feature resource.
|
Returns
Type | Description |
string | number | {string} A string representing the entity_type.
|
matchEvaluationFromModelEvaluationName(modelEvaluationName: string): string | number;
Parse the evaluation from ModelEvaluation resource.
Parameter
Name | Description |
modelEvaluationName |
string
A fully-qualified path representing ModelEvaluation resource.
|
Returns
Type | Description |
string | number | {string} A string representing the evaluation.
|
matchEvaluationFromModelEvaluationSliceName(modelEvaluationSliceName: string): string | number;
Parse the evaluation from ModelEvaluationSlice resource.
Parameter
Name | Description |
modelEvaluationSliceName |
string
A fully-qualified path representing ModelEvaluationSlice resource.
|
Returns
Type | Description |
string | number | {string} A string representing the evaluation.
|
matchExecutionFromExecutionName(executionName: string): string | number;
Parse the execution from Execution resource.
Parameter
Name | Description |
executionName |
string
A fully-qualified path representing Execution resource.
|
Returns
Type | Description |
string | number | {string} A string representing the execution.
|
matchExperimentFromTensorboardExperimentName(tensorboardExperimentName: string): string | number;
Parse the experiment from TensorboardExperiment resource.
Parameter
Name | Description |
tensorboardExperimentName |
string
A fully-qualified path representing TensorboardExperiment resource.
|
Returns
Type | Description |
string | number | {string} A string representing the experiment.
|
matchExperimentFromTensorboardRunName(tensorboardRunName: string): string | number;
Parse the experiment from TensorboardRun resource.
Parameter
Name | Description |
tensorboardRunName |
string
A fully-qualified path representing TensorboardRun resource.
|
Returns
Type | Description |
string | number | {string} A string representing the experiment.
|
matchExperimentFromTensorboardTimeSeriesName(tensorboardTimeSeriesName: string): string | number;
Parse the experiment from TensorboardTimeSeries resource.
Parameter
Name | Description |
tensorboardTimeSeriesName |
string
A fully-qualified path representing TensorboardTimeSeries resource.
|
Returns
Type | Description |
string | number | {string} A string representing the experiment.
|
matchFeatureFromFeatureName(featureName: string): string | number;
Parse the feature from Feature resource.
Parameter
Name | Description |
featureName |
string
A fully-qualified path representing Feature resource.
|
Returns
Type | Description |
string | number | {string} A string representing the feature.
|
matchFeaturestoreFromEntityTypeName(entityTypeName: string): string | number;
Parse the featurestore from EntityType resource.
Parameter
Name | Description |
entityTypeName |
string
A fully-qualified path representing EntityType resource.
|
Returns
Type | Description |
string | number | {string} A string representing the featurestore.
|
matchFeaturestoreFromFeatureName(featureName: string): string | number;
Parse the featurestore from Feature resource.
Parameter
Name | Description |
featureName |
string
A fully-qualified path representing Feature resource.
|
Returns
Type | Description |
string | number | {string} A string representing the featurestore.
|
matchFeaturestoreFromFeaturestoreName(featurestoreName: string): string | number;
Parse the featurestore from Featurestore resource.
Parameter
Name | Description |
featurestoreName |
string
A fully-qualified path representing Featurestore resource.
|
Returns
Type | Description |
string | number | {string} A string representing the featurestore.
|
matchHyperparameterTuningJobFromHyperparameterTuningJobName(hyperparameterTuningJobName: string): string | number;
Parse the hyperparameter_tuning_job from HyperparameterTuningJob resource.
Parameter
Name | Description |
hyperparameterTuningJobName |
string
A fully-qualified path representing HyperparameterTuningJob resource.
|
Returns
Type | Description |
string | number | {string} A string representing the hyperparameter_tuning_job.
|
matchIndexEndpointFromIndexEndpointName(indexEndpointName: string): string | number;
Parse the index_endpoint from IndexEndpoint resource.
Parameter
Name | Description |
indexEndpointName |
string
A fully-qualified path representing IndexEndpoint resource.
|
Returns
Type | Description |
string | number | {string} A string representing the index_endpoint.
|
matchIndexFromIndexName(indexName: string): string | number;
Parse the index from Index resource.
Parameter
Name | Description |
indexName |
string
A fully-qualified path representing Index resource.
|
Returns
Type | Description |
string | number | {string} A string representing the index.
|
matchLocationFromAnnotationName(annotationName: string): string | number;
Parse the location from Annotation resource.
Parameter
Name | Description |
annotationName |
string
A fully-qualified path representing Annotation resource.
|
Returns
Type | Description |
string | number | {string} A string representing the location.
|
matchLocationFromAnnotationSpecName(annotationSpecName: string): string | number;
Parse the location from AnnotationSpec resource.
Parameter
Name | Description |
annotationSpecName |
string
A fully-qualified path representing AnnotationSpec resource.
|
Returns
Type | Description |
string | number | {string} A string representing the location.
|
matchLocationFromArtifactName(artifactName: string): string | number;
Parse the location from Artifact resource.
Parameter
Name | Description |
artifactName |
string
A fully-qualified path representing Artifact resource.
|
Returns
Type | Description |
string | number | {string} A string representing the location.
|
matchLocationFromBatchPredictionJobName(batchPredictionJobName: string): string | number;
Parse the location from BatchPredictionJob resource.
Parameter
Name | Description |
batchPredictionJobName |
string
A fully-qualified path representing BatchPredictionJob resource.
|
Returns
Type | Description |
string | number | {string} A string representing the location.
|
matchLocationFromContextName(contextName)
matchLocationFromContextName(contextName: string): string | number;
Parse the location from Context resource.
Parameter
Name | Description |
contextName |
string
A fully-qualified path representing Context resource.
|
Returns
Type | Description |
string | number | {string} A string representing the location.
|
matchLocationFromCustomJobName(customJobName: string): string | number;
Parse the location from CustomJob resource.
Parameter
Name | Description |
customJobName |
string
A fully-qualified path representing CustomJob resource.
|
Returns
Type | Description |
string | number | {string} A string representing the location.
|
matchLocationFromDataItemName(dataItemName: string): string | number;
Parse the location from DataItem resource.
Parameter
Name | Description |
dataItemName |
string
A fully-qualified path representing DataItem resource.
|
Returns
Type | Description |
string | number | {string} A string representing the location.
|
matchLocationFromDataLabelingJobName(dataLabelingJobName: string): string | number;
Parse the location from DataLabelingJob resource.
Parameter
Name | Description |
dataLabelingJobName |
string
A fully-qualified path representing DataLabelingJob resource.
|
Returns
Type | Description |
string | number | {string} A string representing the location.
|
matchLocationFromDatasetName(datasetName: string): string | number;
Parse the location from Dataset resource.
Parameter
Name | Description |
datasetName |
string
A fully-qualified path representing Dataset resource.
|
Returns
Type | Description |
string | number | {string} A string representing the location.
|
matchLocationFromEndpointName(endpointName: string): string | number;
Parse the location from Endpoint resource.
Parameter
Name | Description |
endpointName |
string
A fully-qualified path representing Endpoint resource.
|
Returns
Type | Description |
string | number | {string} A string representing the location.
|
matchLocationFromEntityTypeName(entityTypeName: string): string | number;
Parse the location from EntityType resource.
Parameter
Name | Description |
entityTypeName |
string
A fully-qualified path representing EntityType resource.
|
Returns
Type | Description |
string | number | {string} A string representing the location.
|
matchLocationFromExecutionName(executionName: string): string | number;
Parse the location from Execution resource.
Parameter
Name | Description |
executionName |
string
A fully-qualified path representing Execution resource.
|
Returns
Type | Description |
string | number | {string} A string representing the location.
|
matchLocationFromFeatureName(featureName: string): string | number;
Parse the location from Feature resource.
Parameter
Name | Description |
featureName |
string
A fully-qualified path representing Feature resource.
|
Returns
Type | Description |
string | number | {string} A string representing the location.
|
matchLocationFromFeaturestoreName(featurestoreName: string): string | number;
Parse the location from Featurestore resource.
Parameter
Name | Description |
featurestoreName |
string
A fully-qualified path representing Featurestore resource.
|
Returns
Type | Description |
string | number | {string} A string representing the location.
|
matchLocationFromHyperparameterTuningJobName(hyperparameterTuningJobName: string): string | number;
Parse the location from HyperparameterTuningJob resource.
Parameter
Name | Description |
hyperparameterTuningJobName |
string
A fully-qualified path representing HyperparameterTuningJob resource.
|
Returns
Type | Description |
string | number | {string} A string representing the location.
|
matchLocationFromIndexEndpointName(indexEndpointName: string): string | number;
Parse the location from IndexEndpoint resource.
Parameter
Name | Description |
indexEndpointName |
string
A fully-qualified path representing IndexEndpoint resource.
|
Returns
Type | Description |
string | number | {string} A string representing the location.
|
matchLocationFromIndexName(indexName: string): string | number;
Parse the location from Index resource.
Parameter
Name | Description |
indexName |
string
A fully-qualified path representing Index resource.
|
Returns
Type | Description |
string | number | {string} A string representing the location.
|
matchLocationFromLocationName(locationName: string): string | number;
Parse the location from Location resource.
Parameter
Name | Description |
locationName |
string
A fully-qualified path representing Location resource.
|
Returns
Type | Description |
string | number | {string} A string representing the location.
|
matchLocationFromMetadataSchemaName(metadataSchemaName: string): string | number;
Parse the location from MetadataSchema resource.
Parameter
Name | Description |
metadataSchemaName |
string
A fully-qualified path representing MetadataSchema resource.
|
Returns
Type | Description |
string | number | {string} A string representing the location.
|
matchLocationFromMetadataStoreName(metadataStoreName: string): string | number;
Parse the location from MetadataStore resource.
Parameter
Name | Description |
metadataStoreName |
string
A fully-qualified path representing MetadataStore resource.
|
Returns
Type | Description |
string | number | {string} A string representing the location.
|
matchLocationFromModelDeploymentMonitoringJobName(modelDeploymentMonitoringJobName: string): string | number;
Parse the location from ModelDeploymentMonitoringJob resource.
Parameter
Name | Description |
modelDeploymentMonitoringJobName |
string
A fully-qualified path representing ModelDeploymentMonitoringJob resource.
|
Returns
Type | Description |
string | number | {string} A string representing the location.
|
matchLocationFromModelEvaluationName(modelEvaluationName: string): string | number;
Parse the location from ModelEvaluation resource.
Parameter
Name | Description |
modelEvaluationName |
string
A fully-qualified path representing ModelEvaluation resource.
|
Returns
Type | Description |
string | number | {string} A string representing the location.
|
matchLocationFromModelEvaluationSliceName(modelEvaluationSliceName: string): string | number;
Parse the location from ModelEvaluationSlice resource.
Parameter
Name | Description |
modelEvaluationSliceName |
string
A fully-qualified path representing ModelEvaluationSlice resource.
|
Returns
Type | Description |
string | number | {string} A string representing the location.
|
matchLocationFromModelName(modelName: string): string | number;
Parse the location from Model resource.
Parameter
Name | Description |
modelName |
string
A fully-qualified path representing Model resource.
|
Returns
Type | Description |
string | number | {string} A string representing the location.
|
matchLocationFromPipelineJobName(pipelineJobName: string): string | number;
Parse the location from PipelineJob resource.
Parameter
Name | Description |
pipelineJobName |
string
A fully-qualified path representing PipelineJob resource.
|
Returns
Type | Description |
string | number | {string} A string representing the location.
|
matchLocationFromSpecialistPoolName(specialistPoolName: string): string | number;
Parse the location from SpecialistPool resource.
Parameter
Name | Description |
specialistPoolName |
string
A fully-qualified path representing SpecialistPool resource.
|
Returns
Type | Description |
string | number | {string} A string representing the location.
|
matchLocationFromStudyName(studyName: string): string | number;
Parse the location from Study resource.
Parameter
Name | Description |
studyName |
string
A fully-qualified path representing Study resource.
|
Returns
Type | Description |
string | number | {string} A string representing the location.
|
matchLocationFromTensorboardExperimentName(tensorboardExperimentName: string): string | number;
Parse the location from TensorboardExperiment resource.
Parameter
Name | Description |
tensorboardExperimentName |
string
A fully-qualified path representing TensorboardExperiment resource.
|
Returns
Type | Description |
string | number | {string} A string representing the location.
|
matchLocationFromTensorboardName(tensorboardName: string): string | number;
Parse the location from Tensorboard resource.
Parameter
Name | Description |
tensorboardName |
string
A fully-qualified path representing Tensorboard resource.
|
Returns
Type | Description |
string | number | {string} A string representing the location.
|
matchLocationFromTensorboardRunName(tensorboardRunName: string): string | number;
Parse the location from TensorboardRun resource.
Parameter
Name | Description |
tensorboardRunName |
string
A fully-qualified path representing TensorboardRun resource.
|
Returns
Type | Description |
string | number | {string} A string representing the location.
|
matchLocationFromTensorboardTimeSeriesName(tensorboardTimeSeriesName: string): string | number;
Parse the location from TensorboardTimeSeries resource.
Parameter
Name | Description |
tensorboardTimeSeriesName |
string
A fully-qualified path representing TensorboardTimeSeries resource.
|
Returns
Type | Description |
string | number | {string} A string representing the location.
|
matchLocationFromTrainingPipelineName(trainingPipelineName: string): string | number;
Parse the location from TrainingPipeline resource.
Parameter
Name | Description |
trainingPipelineName |
string
A fully-qualified path representing TrainingPipeline resource.
|
Returns
Type | Description |
string | number | {string} A string representing the location.
|
matchLocationFromTrialName(trialName: string): string | number;
Parse the location from Trial resource.
Parameter
Name | Description |
trialName |
string
A fully-qualified path representing Trial resource.
|
Returns
Type | Description |
string | number | {string} A string representing the location.
|
matchMetadataSchemaFromMetadataSchemaName(metadataSchemaName: string): string | number;
Parse the metadata_schema from MetadataSchema resource.
Parameter
Name | Description |
metadataSchemaName |
string
A fully-qualified path representing MetadataSchema resource.
|
Returns
Type | Description |
string | number | {string} A string representing the metadata_schema.
|
matchMetadataStoreFromArtifactName(artifactName: string): string | number;
Parse the metadata_store from Artifact resource.
Parameter
Name | Description |
artifactName |
string
A fully-qualified path representing Artifact resource.
|
Returns
Type | Description |
string | number | {string} A string representing the metadata_store.
|
matchMetadataStoreFromContextName(contextName)
matchMetadataStoreFromContextName(contextName: string): string | number;
Parse the metadata_store from Context resource.
Parameter
Name | Description |
contextName |
string
A fully-qualified path representing Context resource.
|
Returns
Type | Description |
string | number | {string} A string representing the metadata_store.
|
matchMetadataStoreFromExecutionName(executionName: string): string | number;
Parse the metadata_store from Execution resource.
Parameter
Name | Description |
executionName |
string
A fully-qualified path representing Execution resource.
|
Returns
Type | Description |
string | number | {string} A string representing the metadata_store.
|
matchMetadataStoreFromMetadataSchemaName(metadataSchemaName: string): string | number;
Parse the metadata_store from MetadataSchema resource.
Parameter
Name | Description |
metadataSchemaName |
string
A fully-qualified path representing MetadataSchema resource.
|
Returns
Type | Description |
string | number | {string} A string representing the metadata_store.
|
matchMetadataStoreFromMetadataStoreName(metadataStoreName: string): string | number;
Parse the metadata_store from MetadataStore resource.
Parameter
Name | Description |
metadataStoreName |
string
A fully-qualified path representing MetadataStore resource.
|
Returns
Type | Description |
string | number | {string} A string representing the metadata_store.
|
matchModelDeploymentMonitoringJobFromModelDeploymentMonitoringJobName(modelDeploymentMonitoringJobName: string): string | number;
Parse the model_deployment_monitoring_job from ModelDeploymentMonitoringJob resource.
Parameter
Name | Description |
modelDeploymentMonitoringJobName |
string
A fully-qualified path representing ModelDeploymentMonitoringJob resource.
|
Returns
Type | Description |
string | number | {string} A string representing the model_deployment_monitoring_job.
|
matchModelFromModelEvaluationName(modelEvaluationName: string): string | number;
Parse the model from ModelEvaluation resource.
Parameter
Name | Description |
modelEvaluationName |
string
A fully-qualified path representing ModelEvaluation resource.
|
Returns
Type | Description |
string | number | {string} A string representing the model.
|
matchModelFromModelEvaluationSliceName(modelEvaluationSliceName: string): string | number;
Parse the model from ModelEvaluationSlice resource.
Parameter
Name | Description |
modelEvaluationSliceName |
string
A fully-qualified path representing ModelEvaluationSlice resource.
|
Returns
Type | Description |
string | number | {string} A string representing the model.
|
matchModelFromModelName(modelName: string): string | number;
Parse the model from Model resource.
Parameter
Name | Description |
modelName |
string
A fully-qualified path representing Model resource.
|
Returns
Type | Description |
string | number | {string} A string representing the model.
|
matchPipelineJobFromPipelineJobName(pipelineJobName: string): string | number;
Parse the pipeline_job from PipelineJob resource.
Parameter
Name | Description |
pipelineJobName |
string
A fully-qualified path representing PipelineJob resource.
|
Returns
Type | Description |
string | number | {string} A string representing the pipeline_job.
|
matchProjectFromAnnotationName(annotationName: string): string | number;
Parse the project from Annotation resource.
Parameter
Name | Description |
annotationName |
string
A fully-qualified path representing Annotation resource.
|
Returns
Type | Description |
string | number | {string} A string representing the project.
|
matchProjectFromAnnotationSpecName(annotationSpecName: string): string | number;
Parse the project from AnnotationSpec resource.
Parameter
Name | Description |
annotationSpecName |
string
A fully-qualified path representing AnnotationSpec resource.
|
Returns
Type | Description |
string | number | {string} A string representing the project.
|
matchProjectFromArtifactName(artifactName: string): string | number;
Parse the project from Artifact resource.
Parameter
Name | Description |
artifactName |
string
A fully-qualified path representing Artifact resource.
|
Returns
Type | Description |
string | number | {string} A string representing the project.
|
matchProjectFromBatchPredictionJobName(batchPredictionJobName: string): string | number;
Parse the project from BatchPredictionJob resource.
Parameter
Name | Description |
batchPredictionJobName |
string
A fully-qualified path representing BatchPredictionJob resource.
|
Returns
Type | Description |
string | number | {string} A string representing the project.
|
matchProjectFromContextName(contextName)
matchProjectFromContextName(contextName: string): string | number;
Parse the project from Context resource.
Parameter
Name | Description |
contextName |
string
A fully-qualified path representing Context resource.
|
Returns
Type | Description |
string | number | {string} A string representing the project.
|
matchProjectFromCustomJobName(customJobName: string): string | number;
Parse the project from CustomJob resource.
Parameter
Name | Description |
customJobName |
string
A fully-qualified path representing CustomJob resource.
|
Returns
Type | Description |
string | number | {string} A string representing the project.
|
matchProjectFromDataItemName(dataItemName: string): string | number;
Parse the project from DataItem resource.
Parameter
Name | Description |
dataItemName |
string
A fully-qualified path representing DataItem resource.
|
Returns
Type | Description |
string | number | {string} A string representing the project.
|
matchProjectFromDataLabelingJobName(dataLabelingJobName: string): string | number;
Parse the project from DataLabelingJob resource.
Parameter
Name | Description |
dataLabelingJobName |
string
A fully-qualified path representing DataLabelingJob resource.
|
Returns
Type | Description |
string | number | {string} A string representing the project.
|
matchProjectFromDatasetName(datasetName: string): string | number;
Parse the project from Dataset resource.
Parameter
Name | Description |
datasetName |
string
A fully-qualified path representing Dataset resource.
|
Returns
Type | Description |
string | number | {string} A string representing the project.
|
matchProjectFromEndpointName(endpointName: string): string | number;
Parse the project from Endpoint resource.
Parameter
Name | Description |
endpointName |
string
A fully-qualified path representing Endpoint resource.
|
Returns
Type | Description |
string | number | {string} A string representing the project.
|
matchProjectFromEntityTypeName(entityTypeName: string): string | number;
Parse the project from EntityType resource.
Parameter
Name | Description |
entityTypeName |
string
A fully-qualified path representing EntityType resource.
|
Returns
Type | Description |
string | number | {string} A string representing the project.
|
matchProjectFromExecutionName(executionName: string): string | number;
Parse the project from Execution resource.
Parameter
Name | Description |
executionName |
string
A fully-qualified path representing Execution resource.
|
Returns
Type | Description |
string | number | {string} A string representing the project.
|
matchProjectFromFeatureName(featureName: string): string | number;
Parse the project from Feature resource.
Parameter
Name | Description |
featureName |
string
A fully-qualified path representing Feature resource.
|
Returns
Type | Description |
string | number | {string} A string representing the project.
|
matchProjectFromFeaturestoreName(featurestoreName: string): string | number;
Parse the project from Featurestore resource.
Parameter
Name | Description |
featurestoreName |
string
A fully-qualified path representing Featurestore resource.
|
Returns
Type | Description |
string | number | {string} A string representing the project.
|
matchProjectFromHyperparameterTuningJobName(hyperparameterTuningJobName: string): string | number;
Parse the project from HyperparameterTuningJob resource.
Parameter
Name | Description |
hyperparameterTuningJobName |
string
A fully-qualified path representing HyperparameterTuningJob resource.
|
Returns
Type | Description |
string | number | {string} A string representing the project.
|
matchProjectFromIndexEndpointName(indexEndpointName: string): string | number;
Parse the project from IndexEndpoint resource.
Parameter
Name | Description |
indexEndpointName |
string
A fully-qualified path representing IndexEndpoint resource.
|
Returns
Type | Description |
string | number | {string} A string representing the project.
|
matchProjectFromIndexName(indexName: string): string | number;
Parse the project from Index resource.
Parameter
Name | Description |
indexName |
string
A fully-qualified path representing Index resource.
|
Returns
Type | Description |
string | number | {string} A string representing the project.
|
matchProjectFromLocationName(locationName: string): string | number;
Parse the project from Location resource.
Parameter
Name | Description |
locationName |
string
A fully-qualified path representing Location resource.
|
Returns
Type | Description |
string | number | {string} A string representing the project.
|
matchProjectFromMetadataSchemaName(metadataSchemaName: string): string | number;
Parse the project from MetadataSchema resource.
Parameter
Name | Description |
metadataSchemaName |
string
A fully-qualified path representing MetadataSchema resource.
|
Returns
Type | Description |
string | number | {string} A string representing the project.
|
matchProjectFromMetadataStoreName(metadataStoreName: string): string | number;
Parse the project from MetadataStore resource.
Parameter
Name | Description |
metadataStoreName |
string
A fully-qualified path representing MetadataStore resource.
|
Returns
Type | Description |
string | number | {string} A string representing the project.
|
matchProjectFromModelDeploymentMonitoringJobName(modelDeploymentMonitoringJobName: string): string | number;
Parse the project from ModelDeploymentMonitoringJob resource.
Parameter
Name | Description |
modelDeploymentMonitoringJobName |
string
A fully-qualified path representing ModelDeploymentMonitoringJob resource.
|
Returns
Type | Description |
string | number | {string} A string representing the project.
|
matchProjectFromModelEvaluationName(modelEvaluationName: string): string | number;
Parse the project from ModelEvaluation resource.
Parameter
Name | Description |
modelEvaluationName |
string
A fully-qualified path representing ModelEvaluation resource.
|
Returns
Type | Description |
string | number | {string} A string representing the project.
|
matchProjectFromModelEvaluationSliceName(modelEvaluationSliceName: string): string | number;
Parse the project from ModelEvaluationSlice resource.
Parameter
Name | Description |
modelEvaluationSliceName |
string
A fully-qualified path representing ModelEvaluationSlice resource.
|
Returns
Type | Description |
string | number | {string} A string representing the project.
|
matchProjectFromModelName(modelName: string): string | number;
Parse the project from Model resource.
Parameter
Name | Description |
modelName |
string
A fully-qualified path representing Model resource.
|
Returns
Type | Description |
string | number | {string} A string representing the project.
|
matchProjectFromPipelineJobName(pipelineJobName: string): string | number;
Parse the project from PipelineJob resource.
Parameter
Name | Description |
pipelineJobName |
string
A fully-qualified path representing PipelineJob resource.
|
Returns
Type | Description |
string | number | {string} A string representing the project.
|
matchProjectFromProjectName(projectName: string): string | number;
Parse the project from Project resource.
Parameter
Name | Description |
projectName |
string
A fully-qualified path representing Project resource.
|
Returns
Type | Description |
string | number | {string} A string representing the project.
|
matchProjectFromSpecialistPoolName(specialistPoolName: string): string | number;
Parse the project from SpecialistPool resource.
Parameter
Name | Description |
specialistPoolName |
string
A fully-qualified path representing SpecialistPool resource.
|
Returns
Type | Description |
string | number | {string} A string representing the project.
|
matchProjectFromStudyName(studyName: string): string | number;
Parse the project from Study resource.
Parameter
Name | Description |
studyName |
string
A fully-qualified path representing Study resource.
|
Returns
Type | Description |
string | number | {string} A string representing the project.
|
matchProjectFromTensorboardExperimentName(tensorboardExperimentName: string): string | number;
Parse the project from TensorboardExperiment resource.
Parameter
Name | Description |
tensorboardExperimentName |
string
A fully-qualified path representing TensorboardExperiment resource.
|
Returns
Type | Description |
string | number | {string} A string representing the project.
|
matchProjectFromTensorboardName(tensorboardName: string): string | number;
Parse the project from Tensorboard resource.
Parameter
Name | Description |
tensorboardName |
string
A fully-qualified path representing Tensorboard resource.
|
Returns
Type | Description |
string | number | {string} A string representing the project.
|
matchProjectFromTensorboardRunName(tensorboardRunName: string): string | number;
Parse the project from TensorboardRun resource.
Parameter
Name | Description |
tensorboardRunName |
string
A fully-qualified path representing TensorboardRun resource.
|
Returns
Type | Description |
string | number | {string} A string representing the project.
|
matchProjectFromTensorboardTimeSeriesName(tensorboardTimeSeriesName: string): string | number;
Parse the project from TensorboardTimeSeries resource.
Parameter
Name | Description |
tensorboardTimeSeriesName |
string
A fully-qualified path representing TensorboardTimeSeries resource.
|
Returns
Type | Description |
string | number | {string} A string representing the project.
|
matchProjectFromTrainingPipelineName(trainingPipelineName: string): string | number;
Parse the project from TrainingPipeline resource.
Parameter
Name | Description |
trainingPipelineName |
string
A fully-qualified path representing TrainingPipeline resource.
|
Returns
Type | Description |
string | number | {string} A string representing the project.
|
matchProjectFromTrialName(trialName: string): string | number;
Parse the project from Trial resource.
Parameter
Name | Description |
trialName |
string
A fully-qualified path representing Trial resource.
|
Returns
Type | Description |
string | number | {string} A string representing the project.
|
matchRunFromTensorboardRunName(tensorboardRunName: string): string | number;
Parse the run from TensorboardRun resource.
Parameter
Name | Description |
tensorboardRunName |
string
A fully-qualified path representing TensorboardRun resource.
|
Returns
Type | Description |
string | number | {string} A string representing the run.
|
matchRunFromTensorboardTimeSeriesName(tensorboardTimeSeriesName: string): string | number;
Parse the run from TensorboardTimeSeries resource.
Parameter
Name | Description |
tensorboardTimeSeriesName |
string
A fully-qualified path representing TensorboardTimeSeries resource.
|
Returns
Type | Description |
string | number | {string} A string representing the run.
|
matchSliceFromModelEvaluationSliceName(modelEvaluationSliceName: string): string | number;
Parse the slice from ModelEvaluationSlice resource.
Parameter
Name | Description |
modelEvaluationSliceName |
string
A fully-qualified path representing ModelEvaluationSlice resource.
|
Returns
Type | Description |
string | number | {string} A string representing the slice.
|
matchSpecialistPoolFromSpecialistPoolName(specialistPoolName: string): string | number;
Parse the specialist_pool from SpecialistPool resource.
Parameter
Name | Description |
specialistPoolName |
string
A fully-qualified path representing SpecialistPool resource.
|
Returns
Type | Description |
string | number | {string} A string representing the specialist_pool.
|
matchStudyFromStudyName(studyName: string): string | number;
Parse the study from Study resource.
Parameter
Name | Description |
studyName |
string
A fully-qualified path representing Study resource.
|
Returns
Type | Description |
string | number | {string} A string representing the study.
|
matchStudyFromTrialName(trialName: string): string | number;
Parse the study from Trial resource.
Parameter
Name | Description |
trialName |
string
A fully-qualified path representing Trial resource.
|
Returns
Type | Description |
string | number | {string} A string representing the study.
|
matchTensorboardFromTensorboardExperimentName(tensorboardExperimentName: string): string | number;
Parse the tensorboard from TensorboardExperiment resource.
Parameter
Name | Description |
tensorboardExperimentName |
string
A fully-qualified path representing TensorboardExperiment resource.
|
Returns
Type | Description |
string | number | {string} A string representing the tensorboard.
|
matchTensorboardFromTensorboardName(tensorboardName: string): string | number;
Parse the tensorboard from Tensorboard resource.
Parameter
Name | Description |
tensorboardName |
string
A fully-qualified path representing Tensorboard resource.
|
Returns
Type | Description |
string | number | {string} A string representing the tensorboard.
|
matchTensorboardFromTensorboardRunName(tensorboardRunName: string): string | number;
Parse the tensorboard from TensorboardRun resource.
Parameter
Name | Description |
tensorboardRunName |
string
A fully-qualified path representing TensorboardRun resource.
|
Returns
Type | Description |
string | number | {string} A string representing the tensorboard.
|
matchTensorboardFromTensorboardTimeSeriesName(tensorboardTimeSeriesName: string): string | number;
Parse the tensorboard from TensorboardTimeSeries resource.
Parameter
Name | Description |
tensorboardTimeSeriesName |
string
A fully-qualified path representing TensorboardTimeSeries resource.
|
Returns
Type | Description |
string | number | {string} A string representing the tensorboard.
|
matchTimeSeriesFromTensorboardTimeSeriesName(tensorboardTimeSeriesName: string): string | number;
Parse the time_series from TensorboardTimeSeries resource.
Parameter
Name | Description |
tensorboardTimeSeriesName |
string
A fully-qualified path representing TensorboardTimeSeries resource.
|
Returns
Type | Description |
string | number | {string} A string representing the time_series.
|
matchTrainingPipelineFromTrainingPipelineName(trainingPipelineName: string): string | number;
Parse the training_pipeline from TrainingPipeline resource.
Parameter
Name | Description |
trainingPipelineName |
string
A fully-qualified path representing TrainingPipeline resource.
|
Returns
Type | Description |
string | number | {string} A string representing the training_pipeline.
|
matchTrialFromTrialName(trialName: string): string | number;
Parse the trial from Trial resource.
Parameter
Name | Description |
trialName |
string
A fully-qualified path representing Trial resource.
|
Returns
Type | Description |
string | number | {string} A string representing the trial.
|
metadataSchemaPath(project: string, location: string, metadataStore: string, metadataSchema: string): string;
Return a fully-qualified metadataSchema resource name string.
Parameters
Name | Description |
project |
string
|
location |
string
|
metadataStore |
string
|
metadataSchema |
string
|
Returns
Type | Description |
string | {string} Resource name string.
|
metadataStorePath(project: string, location: string, metadataStore: string): string;
Return a fully-qualified metadataStore resource name string.
Parameters
Name | Description |
project |
string
|
location |
string
|
metadataStore |
string
|
Returns
Type | Description |
string | {string} Resource name string.
|
modelDeploymentMonitoringJobPath(project: string, location: string, modelDeploymentMonitoringJob: string): string;
Return a fully-qualified modelDeploymentMonitoringJob resource name string.
Parameters
Name | Description |
project |
string
|
location |
string
|
modelDeploymentMonitoringJob |
string
|
Returns
Type | Description |
string | {string} Resource name string.
|
modelEvaluationPath(project: string, location: string, model: string, evaluation: string): string;
Return a fully-qualified modelEvaluation resource name string.
Parameters
Name | Description |
project |
string
|
location |
string
|
model |
string
|
evaluation |
string
|
Returns
Type | Description |
string | {string} Resource name string.
|
modelEvaluationSlicePath(project: string, location: string, model: string, evaluation: string, slice: string): string;
Return a fully-qualified modelEvaluationSlice resource name string.
Parameters
Name | Description |
project |
string
|
location |
string
|
model |
string
|
evaluation |
string
|
slice |
string
|
Returns
Type | Description |
string | {string} Resource name string.
|
modelPath(project: string, location: string, model: string): string;
Return a fully-qualified model resource name string.
Parameters
Name | Description |
project |
string
|
location |
string
|
model |
string
|
Returns
Type | Description |
string | {string} Resource name string.
|
pipelineJobPath(project: string, location: string, pipelineJob: string): string;
Return a fully-qualified pipelineJob resource name string.
Parameters
Name | Description |
project |
string
|
location |
string
|
pipelineJob |
string
|
Returns
Type | Description |
string | {string} Resource name string.
|
projectPath(project: string): string;
Return a fully-qualified project resource name string.
Parameter
Name | Description |
project |
string
|
Returns
Type | Description |
string | {string} Resource name string.
|
readTensorboardBlobData(request?: protos.google.cloud.aiplatform.v1beta1.IReadTensorboardBlobDataRequest, options?: CallOptions): gax.CancellableStream;
Gets bytes of TensorboardBlobs. This is to allow reading blob data stored in consumer project's Cloud Storage bucket without users having to obtain Cloud Storage access permission.
Parameters
Name | Description |
request |
protos.google.cloud.aiplatform.v1beta1.IReadTensorboardBlobDataRequest
The request object that will be sent.
|
options |
CallOptions
Call options. See CallOptions for more details.
|
Returns
Type | Description |
gax.CancellableStream | {Stream} An object stream which emits [ReadTensorboardBlobDataResponse] on 'data' event. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#server-streaming) for more details and examples.
|
Example
const stream = client.readTensorboardBlobData(request); stream.on('data', (response) => { ... }); stream.on('end', () => { ... });
readTensorboardTimeSeriesData(request?: protos.google.cloud.aiplatform.v1beta1.IReadTensorboardTimeSeriesDataRequest, options?: CallOptions): Promise<[
protos.google.cloud.aiplatform.v1beta1.IReadTensorboardTimeSeriesDataResponse,
(protos.google.cloud.aiplatform.v1beta1.IReadTensorboardTimeSeriesDataRequest | undefined),
{} | undefined
]>;
Parameters
Name | Description |
request |
protos.google.cloud.aiplatform.v1beta1.IReadTensorboardTimeSeriesDataRequest
|
options |
CallOptions
|
Returns
Type | Description |
Promise<[
protos.google.cloud.aiplatform.v1beta1.IReadTensorboardTimeSeriesDataResponse,
(protos.google.cloud.aiplatform.v1beta1.IReadTensorboardTimeSeriesDataRequest | undefined),
{} | undefined
]> | |
readTensorboardTimeSeriesData(request: protos.google.cloud.aiplatform.v1beta1.IReadTensorboardTimeSeriesDataRequest, options: CallOptions, callback: Callback<protos.google.cloud.aiplatform.v1beta1.IReadTensorboardTimeSeriesDataResponse, protos.google.cloud.aiplatform.v1beta1.IReadTensorboardTimeSeriesDataRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.cloud.aiplatform.v1beta1.IReadTensorboardTimeSeriesDataRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.cloud.aiplatform.v1beta1.IReadTensorboardTimeSeriesDataResponse, protos.google.cloud.aiplatform.v1beta1.IReadTensorboardTimeSeriesDataRequest | null | undefined, {} | null | undefined>
|
Returns
readTensorboardTimeSeriesData(request: protos.google.cloud.aiplatform.v1beta1.IReadTensorboardTimeSeriesDataRequest, callback: Callback<protos.google.cloud.aiplatform.v1beta1.IReadTensorboardTimeSeriesDataResponse, protos.google.cloud.aiplatform.v1beta1.IReadTensorboardTimeSeriesDataRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.cloud.aiplatform.v1beta1.IReadTensorboardTimeSeriesDataRequest
|
callback |
Callback<protos.google.cloud.aiplatform.v1beta1.IReadTensorboardTimeSeriesDataResponse, protos.google.cloud.aiplatform.v1beta1.IReadTensorboardTimeSeriesDataRequest | null | undefined, {} | null | undefined>
|
Returns
specialistPoolPath(project: string, location: string, specialistPool: string): string;
Return a fully-qualified specialistPool resource name string.
Parameters
Name | Description |
project |
string
|
location |
string
|
specialistPool |
string
|
Returns
Type | Description |
string | {string} Resource name string.
|
studyPath(project: string, location: string, study: string): string;
Return a fully-qualified study resource name string.
Parameters
Name | Description |
project |
string
|
location |
string
|
study |
string
|
Returns
Type | Description |
string | {string} Resource name string.
|
tensorboardExperimentPath(project: string, location: string, tensorboard: string, experiment: string): string;
Return a fully-qualified tensorboardExperiment resource name string.
Parameters
Name | Description |
project |
string
|
location |
string
|
tensorboard |
string
|
experiment |
string
|
Returns
Type | Description |
string | {string} Resource name string.
|
tensorboardPath(project: string, location: string, tensorboard: string): string;
Return a fully-qualified tensorboard resource name string.
Parameters
Name | Description |
project |
string
|
location |
string
|
tensorboard |
string
|
Returns
Type | Description |
string | {string} Resource name string.
|
tensorboardRunPath(project: string, location: string, tensorboard: string, experiment: string, run: string): string;
Return a fully-qualified tensorboardRun resource name string.
Parameters
Name | Description |
project |
string
|
location |
string
|
tensorboard |
string
|
experiment |
string
|
run |
string
|
Returns
Type | Description |
string | {string} Resource name string.
|
tensorboardTimeSeriesPath(project: string, location: string, tensorboard: string, experiment: string, run: string, timeSeries: string): string;
Return a fully-qualified tensorboardTimeSeries resource name string.
Parameters
Name | Description |
project |
string
|
location |
string
|
tensorboard |
string
|
experiment |
string
|
run |
string
|
timeSeries |
string
|
Returns
Type | Description |
string | {string} Resource name string.
|
trainingPipelinePath(project: string, location: string, trainingPipeline: string): string;
Return a fully-qualified trainingPipeline resource name string.
Parameters
Name | Description |
project |
string
|
location |
string
|
trainingPipeline |
string
|
Returns
Type | Description |
string | {string} Resource name string.
|
trialPath(project: string, location: string, study: string, trial: string): string;
Return a fully-qualified trial resource name string.
Parameters
Name | Description |
project |
string
|
location |
string
|
study |
string
|
trial |
string
|
Returns
Type | Description |
string | {string} Resource name string.
|
updateTensorboard(request?: protos.google.cloud.aiplatform.v1beta1.IUpdateTensorboardRequest, options?: CallOptions): Promise<[
LROperation<protos.google.cloud.aiplatform.v1beta1.ITensorboard, protos.google.cloud.aiplatform.v1beta1.IUpdateTensorboardOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]>;
Parameters
Name | Description |
request |
protos.google.cloud.aiplatform.v1beta1.IUpdateTensorboardRequest
|
options |
CallOptions
|
Returns
Type | Description |
Promise<[
LROperation<protos.google.cloud.aiplatform.v1beta1.ITensorboard, protos.google.cloud.aiplatform.v1beta1.IUpdateTensorboardOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]> | |
updateTensorboard(request: protos.google.cloud.aiplatform.v1beta1.IUpdateTensorboardRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.aiplatform.v1beta1.ITensorboard, protos.google.cloud.aiplatform.v1beta1.IUpdateTensorboardOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.cloud.aiplatform.v1beta1.IUpdateTensorboardRequest
|
options |
CallOptions
|
callback |
Callback<LROperation<protos.google.cloud.aiplatform.v1beta1.ITensorboard, protos.google.cloud.aiplatform.v1beta1.IUpdateTensorboardOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
Returns
updateTensorboard(request: protos.google.cloud.aiplatform.v1beta1.IUpdateTensorboardRequest, callback: Callback<LROperation<protos.google.cloud.aiplatform.v1beta1.ITensorboard, protos.google.cloud.aiplatform.v1beta1.IUpdateTensorboardOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.cloud.aiplatform.v1beta1.IUpdateTensorboardRequest
|
callback |
Callback<LROperation<protos.google.cloud.aiplatform.v1beta1.ITensorboard, protos.google.cloud.aiplatform.v1beta1.IUpdateTensorboardOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
Returns
updateTensorboardExperiment(request?: protos.google.cloud.aiplatform.v1beta1.IUpdateTensorboardExperimentRequest, options?: CallOptions): Promise<[
protos.google.cloud.aiplatform.v1beta1.ITensorboardExperiment,
(protos.google.cloud.aiplatform.v1beta1.IUpdateTensorboardExperimentRequest | undefined),
{} | undefined
]>;
Parameters
Name | Description |
request |
protos.google.cloud.aiplatform.v1beta1.IUpdateTensorboardExperimentRequest
|
options |
CallOptions
|
Returns
Type | Description |
Promise<[
protos.google.cloud.aiplatform.v1beta1.ITensorboardExperiment,
(protos.google.cloud.aiplatform.v1beta1.IUpdateTensorboardExperimentRequest | undefined),
{} | undefined
]> | |
updateTensorboardExperiment(request: protos.google.cloud.aiplatform.v1beta1.IUpdateTensorboardExperimentRequest, options: CallOptions, callback: Callback<protos.google.cloud.aiplatform.v1beta1.ITensorboardExperiment, protos.google.cloud.aiplatform.v1beta1.IUpdateTensorboardExperimentRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.cloud.aiplatform.v1beta1.IUpdateTensorboardExperimentRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.cloud.aiplatform.v1beta1.ITensorboardExperiment, protos.google.cloud.aiplatform.v1beta1.IUpdateTensorboardExperimentRequest | null | undefined, {} | null | undefined>
|
Returns
updateTensorboardExperiment(request: protos.google.cloud.aiplatform.v1beta1.IUpdateTensorboardExperimentRequest, callback: Callback<protos.google.cloud.aiplatform.v1beta1.ITensorboardExperiment, protos.google.cloud.aiplatform.v1beta1.IUpdateTensorboardExperimentRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.cloud.aiplatform.v1beta1.IUpdateTensorboardExperimentRequest
|
callback |
Callback<protos.google.cloud.aiplatform.v1beta1.ITensorboardExperiment, protos.google.cloud.aiplatform.v1beta1.IUpdateTensorboardExperimentRequest | null | undefined, {} | null | undefined>
|
Returns
updateTensorboardRun(request?: protos.google.cloud.aiplatform.v1beta1.IUpdateTensorboardRunRequest, options?: CallOptions): Promise<[
protos.google.cloud.aiplatform.v1beta1.ITensorboardRun,
(protos.google.cloud.aiplatform.v1beta1.IUpdateTensorboardRunRequest | undefined),
{} | undefined
]>;
Parameters
Name | Description |
request |
protos.google.cloud.aiplatform.v1beta1.IUpdateTensorboardRunRequest
|
options |
CallOptions
|
Returns
Type | Description |
Promise<[
protos.google.cloud.aiplatform.v1beta1.ITensorboardRun,
(protos.google.cloud.aiplatform.v1beta1.IUpdateTensorboardRunRequest | undefined),
{} | undefined
]> | |
updateTensorboardRun(request: protos.google.cloud.aiplatform.v1beta1.IUpdateTensorboardRunRequest, options: CallOptions, callback: Callback<protos.google.cloud.aiplatform.v1beta1.ITensorboardRun, protos.google.cloud.aiplatform.v1beta1.IUpdateTensorboardRunRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.cloud.aiplatform.v1beta1.IUpdateTensorboardRunRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.cloud.aiplatform.v1beta1.ITensorboardRun, protos.google.cloud.aiplatform.v1beta1.IUpdateTensorboardRunRequest | null | undefined, {} | null | undefined>
|
Returns
updateTensorboardRun(request: protos.google.cloud.aiplatform.v1beta1.IUpdateTensorboardRunRequest, callback: Callback<protos.google.cloud.aiplatform.v1beta1.ITensorboardRun, protos.google.cloud.aiplatform.v1beta1.IUpdateTensorboardRunRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.cloud.aiplatform.v1beta1.IUpdateTensorboardRunRequest
|
callback |
Callback<protos.google.cloud.aiplatform.v1beta1.ITensorboardRun, protos.google.cloud.aiplatform.v1beta1.IUpdateTensorboardRunRequest | null | undefined, {} | null | undefined>
|
Returns
updateTensorboardTimeSeries(request?: protos.google.cloud.aiplatform.v1beta1.IUpdateTensorboardTimeSeriesRequest, options?: CallOptions): Promise<[
protos.google.cloud.aiplatform.v1beta1.ITensorboardTimeSeries,
(protos.google.cloud.aiplatform.v1beta1.IUpdateTensorboardTimeSeriesRequest | undefined),
{} | undefined
]>;
Parameters
Name | Description |
request |
protos.google.cloud.aiplatform.v1beta1.IUpdateTensorboardTimeSeriesRequest
|
options |
CallOptions
|
Returns
Type | Description |
Promise<[
protos.google.cloud.aiplatform.v1beta1.ITensorboardTimeSeries,
(protos.google.cloud.aiplatform.v1beta1.IUpdateTensorboardTimeSeriesRequest | undefined),
{} | undefined
]> | |
updateTensorboardTimeSeries(request: protos.google.cloud.aiplatform.v1beta1.IUpdateTensorboardTimeSeriesRequest, options: CallOptions, callback: Callback<protos.google.cloud.aiplatform.v1beta1.ITensorboardTimeSeries, protos.google.cloud.aiplatform.v1beta1.IUpdateTensorboardTimeSeriesRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.cloud.aiplatform.v1beta1.IUpdateTensorboardTimeSeriesRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.cloud.aiplatform.v1beta1.ITensorboardTimeSeries, protos.google.cloud.aiplatform.v1beta1.IUpdateTensorboardTimeSeriesRequest | null | undefined, {} | null | undefined>
|
Returns
updateTensorboardTimeSeries(request: protos.google.cloud.aiplatform.v1beta1.IUpdateTensorboardTimeSeriesRequest, callback: Callback<protos.google.cloud.aiplatform.v1beta1.ITensorboardTimeSeries, protos.google.cloud.aiplatform.v1beta1.IUpdateTensorboardTimeSeriesRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.cloud.aiplatform.v1beta1.IUpdateTensorboardTimeSeriesRequest
|
callback |
Callback<protos.google.cloud.aiplatform.v1beta1.ITensorboardTimeSeries, protos.google.cloud.aiplatform.v1beta1.IUpdateTensorboardTimeSeriesRequest | null | undefined, {} | null | undefined>
|
Returns
writeTensorboardExperimentData(request?: protos.google.cloud.aiplatform.v1beta1.IWriteTensorboardExperimentDataRequest, options?: CallOptions): Promise<[
protos.google.cloud.aiplatform.v1beta1.IWriteTensorboardExperimentDataResponse,
(protos.google.cloud.aiplatform.v1beta1.IWriteTensorboardExperimentDataRequest | undefined),
{} | undefined
]>;
Parameters
Name | Description |
request |
protos.google.cloud.aiplatform.v1beta1.IWriteTensorboardExperimentDataRequest
|
options |
CallOptions
|
Returns
Type | Description |
Promise<[
protos.google.cloud.aiplatform.v1beta1.IWriteTensorboardExperimentDataResponse,
(protos.google.cloud.aiplatform.v1beta1.IWriteTensorboardExperimentDataRequest | undefined),
{} | undefined
]> | |
writeTensorboardExperimentData(request: protos.google.cloud.aiplatform.v1beta1.IWriteTensorboardExperimentDataRequest, options: CallOptions, callback: Callback<protos.google.cloud.aiplatform.v1beta1.IWriteTensorboardExperimentDataResponse, protos.google.cloud.aiplatform.v1beta1.IWriteTensorboardExperimentDataRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.cloud.aiplatform.v1beta1.IWriteTensorboardExperimentDataRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.cloud.aiplatform.v1beta1.IWriteTensorboardExperimentDataResponse, protos.google.cloud.aiplatform.v1beta1.IWriteTensorboardExperimentDataRequest | null | undefined, {} | null | undefined>
|
Returns
writeTensorboardExperimentData(request: protos.google.cloud.aiplatform.v1beta1.IWriteTensorboardExperimentDataRequest, callback: Callback<protos.google.cloud.aiplatform.v1beta1.IWriteTensorboardExperimentDataResponse, protos.google.cloud.aiplatform.v1beta1.IWriteTensorboardExperimentDataRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.cloud.aiplatform.v1beta1.IWriteTensorboardExperimentDataRequest
|
callback |
Callback<protos.google.cloud.aiplatform.v1beta1.IWriteTensorboardExperimentDataResponse, protos.google.cloud.aiplatform.v1beta1.IWriteTensorboardExperimentDataRequest | null | undefined, {} | null | undefined>
|
Returns
writeTensorboardRunData(request?: protos.google.cloud.aiplatform.v1beta1.IWriteTensorboardRunDataRequest, options?: CallOptions): Promise<[
protos.google.cloud.aiplatform.v1beta1.IWriteTensorboardRunDataResponse,
(protos.google.cloud.aiplatform.v1beta1.IWriteTensorboardRunDataRequest | undefined),
{} | undefined
]>;
Parameters
Name | Description |
request |
protos.google.cloud.aiplatform.v1beta1.IWriteTensorboardRunDataRequest
|
options |
CallOptions
|
Returns
Type | Description |
Promise<[
protos.google.cloud.aiplatform.v1beta1.IWriteTensorboardRunDataResponse,
(protos.google.cloud.aiplatform.v1beta1.IWriteTensorboardRunDataRequest | undefined),
{} | undefined
]> | |
writeTensorboardRunData(request: protos.google.cloud.aiplatform.v1beta1.IWriteTensorboardRunDataRequest, options: CallOptions, callback: Callback<protos.google.cloud.aiplatform.v1beta1.IWriteTensorboardRunDataResponse, protos.google.cloud.aiplatform.v1beta1.IWriteTensorboardRunDataRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.cloud.aiplatform.v1beta1.IWriteTensorboardRunDataRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.cloud.aiplatform.v1beta1.IWriteTensorboardRunDataResponse, protos.google.cloud.aiplatform.v1beta1.IWriteTensorboardRunDataRequest | null | undefined, {} | null | undefined>
|
Returns
writeTensorboardRunData(request: protos.google.cloud.aiplatform.v1beta1.IWriteTensorboardRunDataRequest, callback: Callback<protos.google.cloud.aiplatform.v1beta1.IWriteTensorboardRunDataResponse, protos.google.cloud.aiplatform.v1beta1.IWriteTensorboardRunDataRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.cloud.aiplatform.v1beta1.IWriteTensorboardRunDataRequest
|
callback |
Callback<protos.google.cloud.aiplatform.v1beta1.IWriteTensorboardRunDataResponse, protos.google.cloud.aiplatform.v1beta1.IWriteTensorboardRunDataRequest | null | undefined, {} | null | undefined>
|
Returns