Class v1.TensorboardServiceClient (6.4.0)

Version latest

• 6.2.0 (latest)
• 6.1.0
• 6.0.0
• 5.14.0
• 5.13.0
• 3.15.0
• 3.13.0
• 3.11.0
• 3.10.1
• 3.9.0
• 3.7.0
• 3.6.0
• 3.4.0
• 3.3.0
• 3.0.0
• 2.12.0
• 2.11.0
• 2.10.0
• 2.7.0
• 2.6.1
• 2.5.0
• 2.3.0
• 1.19.0
• 1.18.0
• 1.17.0
• 1.16.0
• 1.15.0
• 1.14.1
• 1.13.0
• 1.11.0
• 1.7.2

TensorboardService v1

Package

@google-cloud/aiplatform

Constructors

(constructor)(opts, gaxInstance)

constructor(opts?: ClientOptions, gaxInstance?: typeof gax | typeof gax.fallback);

Construct an instance of TensorboardServiceClient.

Parameters
Name	Description
opts	ClientOptions
gaxInstance	typeof gax | typeof fallback : loaded instance of google-gax. Useful if you need to avoid loading the default gRPC version and want to use the fallback HTTP implementation. Load only fallback version and pass it to the constructor: ``` const gax = require('google-gax/build/src/fallback'); // avoids loading google-gax with gRPC const client = new TensorboardServiceClient({fallback: true}, gax); ```

Properties

apiEndpoint

get apiEndpoint(): string;

The DNS address for this API service.

apiEndpoint

static get apiEndpoint(): string;

The DNS address for this API service - same as servicePath.

auth

auth: gax.GoogleAuth;

descriptors

descriptors: Descriptors;

iamClient

iamClient: IamClient;

innerApiCalls

innerApiCalls: {
        [name: string]: Function;
    };

locationsClient

locationsClient: LocationsClient;

operationsClient

operationsClient: gax.OperationsClient;

pathTemplates

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

port

static get port(): number;

The port for this API service.

scopes

static get scopes(): string[];

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

servicePath

static get servicePath(): string;

The DNS address for this API service.

tensorboardServiceStub

tensorboardServiceStub?: Promise<{
        [name: string]: Function;
    }>;

universeDomain

get universeDomain(): string;

warn

warn: (code: string, message: string, warnType?: string) => void;

Methods

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

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

Return a fully-qualified annotation resource name string.

Parameters
Name	Description
project	string
location	string
dataset	string
dataItem	string
annotation	string

Returns
Type	Description
string	{string} Resource name string.

annotationSpecPath(project, location, dataset, annotationSpec)

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

Return a fully-qualified annotationSpec resource name string.

Parameters
Name	Description
project	string
location	string
dataset	string
annotationSpec	string

Returns
Type	Description
string	{string} Resource name string.

artifactPath(project, location, metadataStore, artifact)

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

Return a fully-qualified artifact resource name string.

Parameters
Name	Description
project	string
location	string
metadataStore	string
artifact	string

Returns
Type	Description
string	{string} Resource name string.

batchCreateTensorboardRuns(request, options)

batchCreateTensorboardRuns(request?: protos.google.cloud.aiplatform.v1.IBatchCreateTensorboardRunsRequest, options?: CallOptions): Promise<[
        protos.google.cloud.aiplatform.v1.IBatchCreateTensorboardRunsResponse,
        protos.google.cloud.aiplatform.v1.IBatchCreateTensorboardRunsRequest | undefined,
        {} | undefined
    ]>;

Batch create TensorboardRuns.

Parameters
Name	Description
request	IBatchCreateTensorboardRunsRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
Promise<[ protos.google.cloud.aiplatform.v1.IBatchCreateTensorboardRunsResponse, protos.google.cloud.aiplatform.v1.IBatchCreateTensorboardRunsRequest | undefined, {} | undefined ]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing BatchCreateTensorboardRunsResponse. Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The resource name of the TensorboardExperiment to create the
   *  TensorboardRuns in. Format:
   *  `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}`
   *  The parent field in the CreateTensorboardRunRequest messages must match
   *  this field.
   */
  // const parent = 'abc123'
  /**
   *  Required. The request message specifying the TensorboardRuns to create.
   *  A maximum of 1000 TensorboardRuns can be created in a batch.
   */
  // const requests = [1,2,3,4]

  // Imports the Aiplatform library
  const {TensorboardServiceClient} = require('@google-cloud/aiplatform').v1;

  // Instantiates a client
  const aiplatformClient = new TensorboardServiceClient();

  async function callBatchCreateTensorboardRuns() {
    // Construct request
    const request = {
      parent,
      requests,
    };

    // Run request
    const response = await aiplatformClient.batchCreateTensorboardRuns(request);
    console.log(response);
  }

  callBatchCreateTensorboardRuns();

batchCreateTensorboardRuns(request, options, callback)

batchCreateTensorboardRuns(request: protos.google.cloud.aiplatform.v1.IBatchCreateTensorboardRunsRequest, options: CallOptions, callback: Callback<protos.google.cloud.aiplatform.v1.IBatchCreateTensorboardRunsResponse, protos.google.cloud.aiplatform.v1.IBatchCreateTensorboardRunsRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IBatchCreateTensorboardRunsRequest
options	CallOptions
callback	Callback<protos.google.cloud.aiplatform.v1.IBatchCreateTensorboardRunsResponse, protos.google.cloud.aiplatform.v1.IBatchCreateTensorboardRunsRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

batchCreateTensorboardRuns(request, callback)

batchCreateTensorboardRuns(request: protos.google.cloud.aiplatform.v1.IBatchCreateTensorboardRunsRequest, callback: Callback<protos.google.cloud.aiplatform.v1.IBatchCreateTensorboardRunsResponse, protos.google.cloud.aiplatform.v1.IBatchCreateTensorboardRunsRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IBatchCreateTensorboardRunsRequest
callback	Callback<protos.google.cloud.aiplatform.v1.IBatchCreateTensorboardRunsResponse, protos.google.cloud.aiplatform.v1.IBatchCreateTensorboardRunsRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

batchCreateTensorboardTimeSeries(request, options)

batchCreateTensorboardTimeSeries(request?: protos.google.cloud.aiplatform.v1.IBatchCreateTensorboardTimeSeriesRequest, options?: CallOptions): Promise<[
        protos.google.cloud.aiplatform.v1.IBatchCreateTensorboardTimeSeriesResponse,
        protos.google.cloud.aiplatform.v1.IBatchCreateTensorboardTimeSeriesRequest | undefined,
        {} | undefined
    ]>;

Batch create TensorboardTimeSeries that belong to a TensorboardExperiment.

Parameters
Name	Description
request	IBatchCreateTensorboardTimeSeriesRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
Promise<[ protos.google.cloud.aiplatform.v1.IBatchCreateTensorboardTimeSeriesResponse, protos.google.cloud.aiplatform.v1.IBatchCreateTensorboardTimeSeriesRequest | undefined, {} | undefined ]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing BatchCreateTensorboardTimeSeriesResponse. Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The resource name of the TensorboardExperiment to create the
   *  TensorboardTimeSeries in.
   *  Format:
   *  `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}`
   *  The TensorboardRuns referenced by the parent fields in the
   *  CreateTensorboardTimeSeriesRequest messages must be sub resources of this
   *  TensorboardExperiment.
   */
  // const parent = 'abc123'
  /**
   *  Required. The request message specifying the TensorboardTimeSeries to
   *  create. A maximum of 1000 TensorboardTimeSeries can be created in a batch.
   */
  // const requests = [1,2,3,4]

  // Imports the Aiplatform library
  const {TensorboardServiceClient} = require('@google-cloud/aiplatform').v1;

  // Instantiates a client
  const aiplatformClient = new TensorboardServiceClient();

  async function callBatchCreateTensorboardTimeSeries() {
    // Construct request
    const request = {
      parent,
      requests,
    };

    // Run request
    const response = await aiplatformClient.batchCreateTensorboardTimeSeries(request);
    console.log(response);
  }

  callBatchCreateTensorboardTimeSeries();

batchCreateTensorboardTimeSeries(request, options, callback)

batchCreateTensorboardTimeSeries(request: protos.google.cloud.aiplatform.v1.IBatchCreateTensorboardTimeSeriesRequest, options: CallOptions, callback: Callback<protos.google.cloud.aiplatform.v1.IBatchCreateTensorboardTimeSeriesResponse, protos.google.cloud.aiplatform.v1.IBatchCreateTensorboardTimeSeriesRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IBatchCreateTensorboardTimeSeriesRequest
options	CallOptions
callback	Callback<protos.google.cloud.aiplatform.v1.IBatchCreateTensorboardTimeSeriesResponse, protos.google.cloud.aiplatform.v1.IBatchCreateTensorboardTimeSeriesRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

batchCreateTensorboardTimeSeries(request, callback)

batchCreateTensorboardTimeSeries(request: protos.google.cloud.aiplatform.v1.IBatchCreateTensorboardTimeSeriesRequest, callback: Callback<protos.google.cloud.aiplatform.v1.IBatchCreateTensorboardTimeSeriesResponse, protos.google.cloud.aiplatform.v1.IBatchCreateTensorboardTimeSeriesRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IBatchCreateTensorboardTimeSeriesRequest
callback	Callback<protos.google.cloud.aiplatform.v1.IBatchCreateTensorboardTimeSeriesResponse, protos.google.cloud.aiplatform.v1.IBatchCreateTensorboardTimeSeriesRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

batchPredictionJobPath(project, location, batchPredictionJob)

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, options)

batchReadTensorboardTimeSeriesData(request?: protos.google.cloud.aiplatform.v1.IBatchReadTensorboardTimeSeriesDataRequest, options?: CallOptions): Promise<[
        protos.google.cloud.aiplatform.v1.IBatchReadTensorboardTimeSeriesDataResponse,
        protos.google.cloud.aiplatform.v1.IBatchReadTensorboardTimeSeriesDataRequest | undefined,
        {} | undefined
    ]>;

Reads multiple TensorboardTimeSeries' data. The data point number limit is 1000 for scalars, 100 for tensors and blob references. If the number of data points stored is less than the limit, all data is returned. Otherwise, the number limit of data points is randomly selected from this time series and returned.

Parameters
Name	Description
request	IBatchReadTensorboardTimeSeriesDataRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
Promise<[ protos.google.cloud.aiplatform.v1.IBatchReadTensorboardTimeSeriesDataResponse, protos.google.cloud.aiplatform.v1.IBatchReadTensorboardTimeSeriesDataRequest | undefined, {} | undefined ]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing BatchReadTensorboardTimeSeriesDataResponse. Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The resource name of the Tensorboard containing
   *  TensorboardTimeSeries to read data from. Format:
   *  `projects/{project}/locations/{location}/tensorboards/{tensorboard}`.
   *  The TensorboardTimeSeries referenced by
   *  time_series google.cloud.aiplatform.v1.BatchReadTensorboardTimeSeriesDataRequest.time_series 
   *  must be sub resources of this Tensorboard.
   */
  // const tensorboard = 'abc123'
  /**
   *  Required. The resource names of the TensorboardTimeSeries to read data
   *  from. Format:
   *  `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeSeries/{time_series}`
   */
  // const timeSeries = ['abc','def']

  // Imports the Aiplatform library
  const {TensorboardServiceClient} = require('@google-cloud/aiplatform').v1;

  // Instantiates a client
  const aiplatformClient = new TensorboardServiceClient();

  async function callBatchReadTensorboardTimeSeriesData() {
    // Construct request
    const request = {
      tensorboard,
      timeSeries,
    };

    // Run request
    const response = await aiplatformClient.batchReadTensorboardTimeSeriesData(request);
    console.log(response);
  }

  callBatchReadTensorboardTimeSeriesData();

batchReadTensorboardTimeSeriesData(request, options, callback)

batchReadTensorboardTimeSeriesData(request: protos.google.cloud.aiplatform.v1.IBatchReadTensorboardTimeSeriesDataRequest, options: CallOptions, callback: Callback<protos.google.cloud.aiplatform.v1.IBatchReadTensorboardTimeSeriesDataResponse, protos.google.cloud.aiplatform.v1.IBatchReadTensorboardTimeSeriesDataRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IBatchReadTensorboardTimeSeriesDataRequest
options	CallOptions
callback	Callback<protos.google.cloud.aiplatform.v1.IBatchReadTensorboardTimeSeriesDataResponse, protos.google.cloud.aiplatform.v1.IBatchReadTensorboardTimeSeriesDataRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

batchReadTensorboardTimeSeriesData(request, callback)

batchReadTensorboardTimeSeriesData(request: protos.google.cloud.aiplatform.v1.IBatchReadTensorboardTimeSeriesDataRequest, callback: Callback<protos.google.cloud.aiplatform.v1.IBatchReadTensorboardTimeSeriesDataResponse, protos.google.cloud.aiplatform.v1.IBatchReadTensorboardTimeSeriesDataRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IBatchReadTensorboardTimeSeriesDataRequest
callback	Callback<protos.google.cloud.aiplatform.v1.IBatchReadTensorboardTimeSeriesDataResponse, protos.google.cloud.aiplatform.v1.IBatchReadTensorboardTimeSeriesDataRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

cachedContentPath(project, location, cachedContent)

cachedContentPath(project: string, location: string, cachedContent: string): string;

Return a fully-qualified cachedContent resource name string.

Parameters
Name	Description
project	string
location	string
cachedContent	string

Returns
Type	Description
string	{string} Resource name string.

cancelOperation(request, optionsOrCallback, callback)

cancelOperation(request: protos.google.longrunning.CancelOperationRequest, optionsOrCallback?: gax.CallOptions | Callback<protos.google.longrunning.CancelOperationRequest, protos.google.protobuf.Empty, {} | undefined | null>, callback?: Callback<protos.google.longrunning.CancelOperationRequest, protos.google.protobuf.Empty, {} | undefined | null>): Promise<protos.google.protobuf.Empty>;

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED. Clients can use or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an value with a of 1, corresponding to Code.CANCELLED.

Parameters
Name	Description
request	CancelOperationRequest The request object that will be sent.
optionsOrCallback	CallOptions | Callback<protos.google.longrunning.CancelOperationRequest, protos.google.protobuf.Empty, {} | undefined | null>
callback	Callback<protos.google.longrunning.CancelOperationRequest, protos.google.protobuf.Empty, {} | undefined | null> The function which will be called with the result of the API call. {Promise} - The promise which resolves when API call finishes. The promise has a method named "cancel" which cancels the ongoing API call.

Returns
Type	Description
Promise<protos.google.protobuf.Empty>

Example

const client = longrunning.operationsClient();
await client.cancelOperation({name: ''});

checkCreateTensorboardProgress(name)

checkCreateTensorboardProgress(name: string): Promise<LROperation<protos.google.cloud.aiplatform.v1.Tensorboard, protos.google.cloud.aiplatform.v1.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.v1.Tensorboard, protos.google.cloud.aiplatform.v1.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 for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The resource name of the Location to create the Tensorboard in.
   *  Format: `projects/{project}/locations/{location}`
   */
  // const parent = 'abc123'
  /**
   *  Required. The Tensorboard to create.
   */
  // const tensorboard = {}

  // Imports the Aiplatform library
  const {TensorboardServiceClient} = require('@google-cloud/aiplatform').v1;

  // Instantiates a client
  const aiplatformClient = new TensorboardServiceClient();

  async function callCreateTensorboard() {
    // Construct request
    const request = {
      parent,
      tensorboard,
    };

    // Run request
    const [operation] = await aiplatformClient.createTensorboard(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callCreateTensorboard();

checkDeleteTensorboardExperimentProgress(name)

checkDeleteTensorboardExperimentProgress(name: string): Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.aiplatform.v1.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.v1.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 for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The name of the TensorboardExperiment to be deleted.
   *  Format:
   *  `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}`
   */
  // const name = 'abc123'

  // Imports the Aiplatform library
  const {TensorboardServiceClient} = require('@google-cloud/aiplatform').v1;

  // Instantiates a client
  const aiplatformClient = new TensorboardServiceClient();

  async function callDeleteTensorboardExperiment() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const [operation] = await aiplatformClient.deleteTensorboardExperiment(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callDeleteTensorboardExperiment();

checkDeleteTensorboardProgress(name)

checkDeleteTensorboardProgress(name: string): Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.aiplatform.v1.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.v1.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 for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The name of the Tensorboard to be deleted.
   *  Format:
   *  `projects/{project}/locations/{location}/tensorboards/{tensorboard}`
   */
  // const name = 'abc123'

  // Imports the Aiplatform library
  const {TensorboardServiceClient} = require('@google-cloud/aiplatform').v1;

  // Instantiates a client
  const aiplatformClient = new TensorboardServiceClient();

  async function callDeleteTensorboard() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const [operation] = await aiplatformClient.deleteTensorboard(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callDeleteTensorboard();

checkDeleteTensorboardRunProgress(name)

checkDeleteTensorboardRunProgress(name: string): Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.aiplatform.v1.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.v1.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 for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The name of the TensorboardRun to be deleted.
   *  Format:
   *  `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}`
   */
  // const name = 'abc123'

  // Imports the Aiplatform library
  const {TensorboardServiceClient} = require('@google-cloud/aiplatform').v1;

  // Instantiates a client
  const aiplatformClient = new TensorboardServiceClient();

  async function callDeleteTensorboardRun() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const [operation] = await aiplatformClient.deleteTensorboardRun(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callDeleteTensorboardRun();

checkDeleteTensorboardTimeSeriesProgress(name)

checkDeleteTensorboardTimeSeriesProgress(name: string): Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.aiplatform.v1.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.v1.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 for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The name of the TensorboardTimeSeries to be deleted.
   *  Format:
   *  `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeSeries/{time_series}`
   */
  // const name = 'abc123'

  // Imports the Aiplatform library
  const {TensorboardServiceClient} = require('@google-cloud/aiplatform').v1;

  // Instantiates a client
  const aiplatformClient = new TensorboardServiceClient();

  async function callDeleteTensorboardTimeSeries() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const [operation] = await aiplatformClient.deleteTensorboardTimeSeries(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callDeleteTensorboardTimeSeries();

checkUpdateTensorboardProgress(name)

checkUpdateTensorboardProgress(name: string): Promise<LROperation<protos.google.cloud.aiplatform.v1.Tensorboard, protos.google.cloud.aiplatform.v1.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.v1.Tensorboard, protos.google.cloud.aiplatform.v1.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 for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. Field mask is used to specify the fields to be overwritten in the
   *  Tensorboard resource by the update.
   *  The fields specified in the update_mask are relative to the resource, not
   *  the full request. A field is overwritten if it's in the mask. If the
   *  user does not provide a mask then all fields are overwritten if new
   *  values are specified.
   */
  // const updateMask = {}
  /**
   *  Required. The Tensorboard's `name` field is used to identify the
   *  Tensorboard to be updated. Format:
   *  `projects/{project}/locations/{location}/tensorboards/{tensorboard}`
   */
  // const tensorboard = {}

  // Imports the Aiplatform library
  const {TensorboardServiceClient} = require('@google-cloud/aiplatform').v1;

  // Instantiates a client
  const aiplatformClient = new TensorboardServiceClient();

  async function callUpdateTensorboard() {
    // Construct request
    const request = {
      updateMask,
      tensorboard,
    };

    // Run request
    const [operation] = await aiplatformClient.updateTensorboard(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callUpdateTensorboard();

close()

close(): Promise<void>;

Terminate the gRPC channel and close the client.

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

Returns
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, options)

createTensorboard(request?: protos.google.cloud.aiplatform.v1.ICreateTensorboardRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.aiplatform.v1.ITensorboard, protos.google.cloud.aiplatform.v1.ICreateTensorboardOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Creates a Tensorboard.

Parameters
Name	Description
request	ICreateTensorboardRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
Promise<[ LROperation<protos.google.cloud.aiplatform.v1.ITensorboard, protos.google.cloud.aiplatform.v1.ICreateTensorboardOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined ]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its promise() method returns a promise you can await for. Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The resource name of the Location to create the Tensorboard in.
   *  Format: `projects/{project}/locations/{location}`
   */
  // const parent = 'abc123'
  /**
   *  Required. The Tensorboard to create.
   */
  // const tensorboard = {}

  // Imports the Aiplatform library
  const {TensorboardServiceClient} = require('@google-cloud/aiplatform').v1;

  // Instantiates a client
  const aiplatformClient = new TensorboardServiceClient();

  async function callCreateTensorboard() {
    // Construct request
    const request = {
      parent,
      tensorboard,
    };

    // Run request
    const [operation] = await aiplatformClient.createTensorboard(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callCreateTensorboard();

createTensorboard(request, options, callback)

createTensorboard(request: protos.google.cloud.aiplatform.v1.ICreateTensorboardRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.aiplatform.v1.ITensorboard, protos.google.cloud.aiplatform.v1.ICreateTensorboardOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	ICreateTensorboardRequest
options	CallOptions
callback	Callback<LROperation<protos.google.cloud.aiplatform.v1.ITensorboard, protos.google.cloud.aiplatform.v1.ICreateTensorboardOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>

Returns
Type	Description
void

createTensorboard(request, callback)

createTensorboard(request: protos.google.cloud.aiplatform.v1.ICreateTensorboardRequest, callback: Callback<LROperation<protos.google.cloud.aiplatform.v1.ITensorboard, protos.google.cloud.aiplatform.v1.ICreateTensorboardOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	ICreateTensorboardRequest
callback	Callback<LROperation<protos.google.cloud.aiplatform.v1.ITensorboard, protos.google.cloud.aiplatform.v1.ICreateTensorboardOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>

Returns
Type	Description
void

createTensorboardExperiment(request, options)

createTensorboardExperiment(request?: protos.google.cloud.aiplatform.v1.ICreateTensorboardExperimentRequest, options?: CallOptions): Promise<[
        protos.google.cloud.aiplatform.v1.ITensorboardExperiment,
        protos.google.cloud.aiplatform.v1.ICreateTensorboardExperimentRequest | undefined,
        {} | undefined
    ]>;

Creates a TensorboardExperiment.

Parameters
Name	Description
request	ICreateTensorboardExperimentRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
Promise<[ protos.google.cloud.aiplatform.v1.ITensorboardExperiment, protos.google.cloud.aiplatform.v1.ICreateTensorboardExperimentRequest | undefined, {} | undefined ]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing TensorboardExperiment. Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The resource name of the Tensorboard to create the
   *  TensorboardExperiment in. Format:
   *  `projects/{project}/locations/{location}/tensorboards/{tensorboard}`
   */
  // const parent = 'abc123'
  /**
   *  The TensorboardExperiment to create.
   */
  // const tensorboardExperiment = {}
  /**
   *  Required. The ID to use for the Tensorboard experiment, which becomes the
   *  final component of the Tensorboard experiment's resource name.
   *  This value should be 1-128 characters, and valid characters
   *  are `/[a-z][0-9]-/`.
   */
  // const tensorboardExperimentId = 'abc123'

  // Imports the Aiplatform library
  const {TensorboardServiceClient} = require('@google-cloud/aiplatform').v1;

  // Instantiates a client
  const aiplatformClient = new TensorboardServiceClient();

  async function callCreateTensorboardExperiment() {
    // Construct request
    const request = {
      parent,
      tensorboardExperimentId,
    };

    // Run request
    const response = await aiplatformClient.createTensorboardExperiment(request);
    console.log(response);
  }

  callCreateTensorboardExperiment();

createTensorboardExperiment(request, options, callback)

createTensorboardExperiment(request: protos.google.cloud.aiplatform.v1.ICreateTensorboardExperimentRequest, options: CallOptions, callback: Callback<protos.google.cloud.aiplatform.v1.ITensorboardExperiment, protos.google.cloud.aiplatform.v1.ICreateTensorboardExperimentRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	ICreateTensorboardExperimentRequest
options	CallOptions
callback	Callback<protos.google.cloud.aiplatform.v1.ITensorboardExperiment, protos.google.cloud.aiplatform.v1.ICreateTensorboardExperimentRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

createTensorboardExperiment(request, callback)

createTensorboardExperiment(request: protos.google.cloud.aiplatform.v1.ICreateTensorboardExperimentRequest, callback: Callback<protos.google.cloud.aiplatform.v1.ITensorboardExperiment, protos.google.cloud.aiplatform.v1.ICreateTensorboardExperimentRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	ICreateTensorboardExperimentRequest
callback	Callback<protos.google.cloud.aiplatform.v1.ITensorboardExperiment, protos.google.cloud.aiplatform.v1.ICreateTensorboardExperimentRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

createTensorboardRun(request, options)

createTensorboardRun(request?: protos.google.cloud.aiplatform.v1.ICreateTensorboardRunRequest, options?: CallOptions): Promise<[
        protos.google.cloud.aiplatform.v1.ITensorboardRun,
        protos.google.cloud.aiplatform.v1.ICreateTensorboardRunRequest | undefined,
        {} | undefined
    ]>;

Creates a TensorboardRun.

Parameters
Name	Description
request	ICreateTensorboardRunRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
Promise<[ protos.google.cloud.aiplatform.v1.ITensorboardRun, protos.google.cloud.aiplatform.v1.ICreateTensorboardRunRequest | undefined, {} | undefined ]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing TensorboardRun. Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The resource name of the TensorboardExperiment to create the
   *  TensorboardRun in. Format:
   *  `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}`
   */
  // const parent = 'abc123'
  /**
   *  Required. The TensorboardRun to create.
   */
  // const tensorboardRun = {}
  /**
   *  Required. The ID to use for the Tensorboard run, which becomes the final
   *  component of the Tensorboard run's resource name.
   *  This value should be 1-128 characters, and valid characters
   *  are `/[a-z][0-9]-/`.
   */
  // const tensorboardRunId = 'abc123'

  // Imports the Aiplatform library
  const {TensorboardServiceClient} = require('@google-cloud/aiplatform').v1;

  // Instantiates a client
  const aiplatformClient = new TensorboardServiceClient();

  async function callCreateTensorboardRun() {
    // Construct request
    const request = {
      parent,
      tensorboardRun,
      tensorboardRunId,
    };

    // Run request
    const response = await aiplatformClient.createTensorboardRun(request);
    console.log(response);
  }

  callCreateTensorboardRun();

createTensorboardRun(request, options, callback)

createTensorboardRun(request: protos.google.cloud.aiplatform.v1.ICreateTensorboardRunRequest, options: CallOptions, callback: Callback<protos.google.cloud.aiplatform.v1.ITensorboardRun, protos.google.cloud.aiplatform.v1.ICreateTensorboardRunRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	ICreateTensorboardRunRequest
options	CallOptions
callback	Callback<protos.google.cloud.aiplatform.v1.ITensorboardRun, protos.google.cloud.aiplatform.v1.ICreateTensorboardRunRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

createTensorboardRun(request, callback)

createTensorboardRun(request: protos.google.cloud.aiplatform.v1.ICreateTensorboardRunRequest, callback: Callback<protos.google.cloud.aiplatform.v1.ITensorboardRun, protos.google.cloud.aiplatform.v1.ICreateTensorboardRunRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	ICreateTensorboardRunRequest
callback	Callback<protos.google.cloud.aiplatform.v1.ITensorboardRun, protos.google.cloud.aiplatform.v1.ICreateTensorboardRunRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

createTensorboardTimeSeries(request, options)

createTensorboardTimeSeries(request?: protos.google.cloud.aiplatform.v1.ICreateTensorboardTimeSeriesRequest, options?: CallOptions): Promise<[
        protos.google.cloud.aiplatform.v1.ITensorboardTimeSeries,
        protos.google.cloud.aiplatform.v1.ICreateTensorboardTimeSeriesRequest | undefined,
        {} | undefined
    ]>;

Creates a TensorboardTimeSeries.

Parameters
Name	Description
request	ICreateTensorboardTimeSeriesRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
Promise<[ protos.google.cloud.aiplatform.v1.ITensorboardTimeSeries, protos.google.cloud.aiplatform.v1.ICreateTensorboardTimeSeriesRequest | undefined, {} | undefined ]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The resource name of the TensorboardRun to create the
   *  TensorboardTimeSeries in.
   *  Format:
   *  `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}`
   */
  // const parent = 'abc123'
  /**
   *  Optional. The user specified unique ID to use for the
   *  TensorboardTimeSeries, which becomes the final component of the
   *  TensorboardTimeSeries's resource name. This value should match
   *  "[a-z0-9][a-z0-9-]{0, 127}"
   */
  // const tensorboardTimeSeriesId = 'abc123'
  /**
   *  Required. The TensorboardTimeSeries to create.
   */
  // const tensorboardTimeSeries = {}

  // Imports the Aiplatform library
  const {TensorboardServiceClient} = require('@google-cloud/aiplatform').v1;

  // Instantiates a client
  const aiplatformClient = new TensorboardServiceClient();

  async function callCreateTensorboardTimeSeries() {
    // Construct request
    const request = {
      parent,
      tensorboardTimeSeries,
    };

    // Run request
    const response = await aiplatformClient.createTensorboardTimeSeries(request);
    console.log(response);
  }

  callCreateTensorboardTimeSeries();

createTensorboardTimeSeries(request, options, callback)

createTensorboardTimeSeries(request: protos.google.cloud.aiplatform.v1.ICreateTensorboardTimeSeriesRequest, options: CallOptions, callback: Callback<protos.google.cloud.aiplatform.v1.ITensorboardTimeSeries, protos.google.cloud.aiplatform.v1.ICreateTensorboardTimeSeriesRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	ICreateTensorboardTimeSeriesRequest
options	CallOptions
callback	Callback<protos.google.cloud.aiplatform.v1.ITensorboardTimeSeries, protos.google.cloud.aiplatform.v1.ICreateTensorboardTimeSeriesRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

createTensorboardTimeSeries(request, callback)

createTensorboardTimeSeries(request: protos.google.cloud.aiplatform.v1.ICreateTensorboardTimeSeriesRequest, callback: Callback<protos.google.cloud.aiplatform.v1.ITensorboardTimeSeries, protos.google.cloud.aiplatform.v1.ICreateTensorboardTimeSeriesRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	ICreateTensorboardTimeSeriesRequest
callback	Callback<protos.google.cloud.aiplatform.v1.ITensorboardTimeSeries, protos.google.cloud.aiplatform.v1.ICreateTensorboardTimeSeriesRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

customJobPath(project, location, customJob)

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, location, dataset, dataItem)

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, location, dataLabelingJob)

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, location, dataset)

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.

datasetVersionPath(project, location, dataset, datasetVersion)

datasetVersionPath(project: string, location: string, dataset: string, datasetVersion: string): string;

Return a fully-qualified datasetVersion resource name string.

Parameters
Name	Description
project	string
location	string
dataset	string
datasetVersion	string

Returns
Type	Description
string	{string} Resource name string.

deleteOperation(request, optionsOrCallback, callback)

deleteOperation(request: protos.google.longrunning.DeleteOperationRequest, optionsOrCallback?: gax.CallOptions | Callback<protos.google.protobuf.Empty, protos.google.longrunning.DeleteOperationRequest, {} | null | undefined>, callback?: Callback<protos.google.protobuf.Empty, protos.google.longrunning.DeleteOperationRequest, {} | null | undefined>): Promise<protos.google.protobuf.Empty>;

Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED.

Parameters
Name	Description
request	DeleteOperationRequest The request object that will be sent.
optionsOrCallback	CallOptions | Callback<protos.google.protobuf.Empty, protos.google.longrunning.DeleteOperationRequest, {} | null | undefined>
callback	Callback<protos.google.protobuf.Empty, protos.google.longrunning.DeleteOperationRequest, {} | null | undefined> The function which will be called with the result of the API call. {Promise} - The promise which resolves when API call finishes. The promise has a method named "cancel" which cancels the ongoing API call.

Returns
Type	Description
Promise<protos.google.protobuf.Empty>

Example

const client = longrunning.operationsClient();
await client.deleteOperation({name: ''});

deleteTensorboard(request, options)

deleteTensorboard(request?: protos.google.cloud.aiplatform.v1.IDeleteTensorboardRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.aiplatform.v1.IDeleteOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Deletes a Tensorboard.

Parameters
Name	Description
request	IDeleteTensorboardRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
Promise<[ LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.aiplatform.v1.IDeleteOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined ]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its promise() method returns a promise you can await for. Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The name of the Tensorboard to be deleted.
   *  Format:
   *  `projects/{project}/locations/{location}/tensorboards/{tensorboard}`
   */
  // const name = 'abc123'

  // Imports the Aiplatform library
  const {TensorboardServiceClient} = require('@google-cloud/aiplatform').v1;

  // Instantiates a client
  const aiplatformClient = new TensorboardServiceClient();

  async function callDeleteTensorboard() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const [operation] = await aiplatformClient.deleteTensorboard(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callDeleteTensorboard();

deleteTensorboard(request, options, callback)

deleteTensorboard(request: protos.google.cloud.aiplatform.v1.IDeleteTensorboardRequest, options: CallOptions, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.aiplatform.v1.IDeleteOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IDeleteTensorboardRequest
options	CallOptions
callback	Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.aiplatform.v1.IDeleteOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>

Returns
Type	Description
void

deleteTensorboard(request, callback)

deleteTensorboard(request: protos.google.cloud.aiplatform.v1.IDeleteTensorboardRequest, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.aiplatform.v1.IDeleteOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IDeleteTensorboardRequest
callback	Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.aiplatform.v1.IDeleteOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>

Returns
Type	Description
void

deleteTensorboardExperiment(request, options)

deleteTensorboardExperiment(request?: protos.google.cloud.aiplatform.v1.IDeleteTensorboardExperimentRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.aiplatform.v1.IDeleteOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Deletes a TensorboardExperiment.

Parameters
Name	Description
request	IDeleteTensorboardExperimentRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
Promise<[ LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.aiplatform.v1.IDeleteOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined ]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its promise() method returns a promise you can await for. Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The name of the TensorboardExperiment to be deleted.
   *  Format:
   *  `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}`
   */
  // const name = 'abc123'

  // Imports the Aiplatform library
  const {TensorboardServiceClient} = require('@google-cloud/aiplatform').v1;

  // Instantiates a client
  const aiplatformClient = new TensorboardServiceClient();

  async function callDeleteTensorboardExperiment() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const [operation] = await aiplatformClient.deleteTensorboardExperiment(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callDeleteTensorboardExperiment();

deleteTensorboardExperiment(request, options, callback)

deleteTensorboardExperiment(request: protos.google.cloud.aiplatform.v1.IDeleteTensorboardExperimentRequest, options: CallOptions, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.aiplatform.v1.IDeleteOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IDeleteTensorboardExperimentRequest
options	CallOptions
callback	Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.aiplatform.v1.IDeleteOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>

Returns
Type	Description
void

deleteTensorboardExperiment(request, callback)

deleteTensorboardExperiment(request: protos.google.cloud.aiplatform.v1.IDeleteTensorboardExperimentRequest, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.aiplatform.v1.IDeleteOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IDeleteTensorboardExperimentRequest
callback	Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.aiplatform.v1.IDeleteOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>

Returns
Type	Description
void

deleteTensorboardRun(request, options)

deleteTensorboardRun(request?: protos.google.cloud.aiplatform.v1.IDeleteTensorboardRunRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.aiplatform.v1.IDeleteOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Deletes a TensorboardRun.

Parameters
Name	Description
request	IDeleteTensorboardRunRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
Promise<[ LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.aiplatform.v1.IDeleteOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined ]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its promise() method returns a promise you can await for. Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The name of the TensorboardRun to be deleted.
   *  Format:
   *  `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}`
   */
  // const name = 'abc123'

  // Imports the Aiplatform library
  const {TensorboardServiceClient} = require('@google-cloud/aiplatform').v1;

  // Instantiates a client
  const aiplatformClient = new TensorboardServiceClient();

  async function callDeleteTensorboardRun() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const [operation] = await aiplatformClient.deleteTensorboardRun(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callDeleteTensorboardRun();

deleteTensorboardRun(request, options, callback)

deleteTensorboardRun(request: protos.google.cloud.aiplatform.v1.IDeleteTensorboardRunRequest, options: CallOptions, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.aiplatform.v1.IDeleteOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IDeleteTensorboardRunRequest
options	CallOptions
callback	Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.aiplatform.v1.IDeleteOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>

Returns
Type	Description
void

deleteTensorboardRun(request, callback)

deleteTensorboardRun(request: protos.google.cloud.aiplatform.v1.IDeleteTensorboardRunRequest, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.aiplatform.v1.IDeleteOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IDeleteTensorboardRunRequest
callback	Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.aiplatform.v1.IDeleteOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>

Returns
Type	Description
void

deleteTensorboardTimeSeries(request, options)

deleteTensorboardTimeSeries(request?: protos.google.cloud.aiplatform.v1.IDeleteTensorboardTimeSeriesRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.aiplatform.v1.IDeleteOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Deletes a TensorboardTimeSeries.

Parameters
Name	Description
request	IDeleteTensorboardTimeSeriesRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
Promise<[ LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.aiplatform.v1.IDeleteOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined ]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its promise() method returns a promise you can await for. Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The name of the TensorboardTimeSeries to be deleted.
   *  Format:
   *  `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeSeries/{time_series}`
   */
  // const name = 'abc123'

  // Imports the Aiplatform library
  const {TensorboardServiceClient} = require('@google-cloud/aiplatform').v1;

  // Instantiates a client
  const aiplatformClient = new TensorboardServiceClient();

  async function callDeleteTensorboardTimeSeries() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const [operation] = await aiplatformClient.deleteTensorboardTimeSeries(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callDeleteTensorboardTimeSeries();

deleteTensorboardTimeSeries(request, options, callback)

deleteTensorboardTimeSeries(request: protos.google.cloud.aiplatform.v1.IDeleteTensorboardTimeSeriesRequest, options: CallOptions, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.aiplatform.v1.IDeleteOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IDeleteTensorboardTimeSeriesRequest
options	CallOptions
callback	Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.aiplatform.v1.IDeleteOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>

Returns
Type	Description
void

deleteTensorboardTimeSeries(request, callback)

deleteTensorboardTimeSeries(request: protos.google.cloud.aiplatform.v1.IDeleteTensorboardTimeSeriesRequest, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.aiplatform.v1.IDeleteOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IDeleteTensorboardTimeSeriesRequest
callback	Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.aiplatform.v1.IDeleteOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>

Returns
Type	Description
void

deploymentResourcePoolPath(project, location, deploymentResourcePool)

deploymentResourcePoolPath(project: string, location: string, deploymentResourcePool: string): string;

Return a fully-qualified deploymentResourcePool resource name string.

Parameters
Name	Description
project	string
location	string
deploymentResourcePool	string

Returns
Type	Description
string	{string} Resource name string.

entityTypePath(project, location, featurestore, entityType)

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

Return a fully-qualified entityType resource name string.

Parameters
Name	Description
project	string
location	string
featurestore	string
entityType	string

Returns
Type	Description
string	{string} Resource name string.

executionPath(project, location, metadataStore, execution)

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

Return a fully-qualified execution resource name string.

Parameters
Name	Description
project	string
location	string
metadataStore	string
execution	string

Returns
Type	Description
string	{string} Resource name string.

exportTensorboardTimeSeriesData(request, options)

exportTensorboardTimeSeriesData(request?: protos.google.cloud.aiplatform.v1.IExportTensorboardTimeSeriesDataRequest, options?: CallOptions): Promise<[
        protos.google.cloud.aiplatform.v1.ITimeSeriesDataPoint[],
        protos.google.cloud.aiplatform.v1.IExportTensorboardTimeSeriesDataRequest | null,
        protos.google.cloud.aiplatform.v1.IExportTensorboardTimeSeriesDataResponse
    ]>;

Exports a TensorboardTimeSeries' data. Data is returned in paginated responses.

Parameters
Name	Description
request	IExportTensorboardTimeSeriesDataRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
Promise<[ protos.google.cloud.aiplatform.v1.ITimeSeriesDataPoint[], protos.google.cloud.aiplatform.v1.IExportTensorboardTimeSeriesDataRequest | null, protos.google.cloud.aiplatform.v1.IExportTensorboardTimeSeriesDataResponse ]>	{Promise} - The promise which resolves to an array. The first element of the array is Array of TimeSeriesDataPoint. The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. 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 for more details and examples.

exportTensorboardTimeSeriesData(request, options, callback)

exportTensorboardTimeSeriesData(request: protos.google.cloud.aiplatform.v1.IExportTensorboardTimeSeriesDataRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.aiplatform.v1.IExportTensorboardTimeSeriesDataRequest, protos.google.cloud.aiplatform.v1.IExportTensorboardTimeSeriesDataResponse | null | undefined, protos.google.cloud.aiplatform.v1.ITimeSeriesDataPoint>): void;

Parameters
Name	Description
request	IExportTensorboardTimeSeriesDataRequest
options	CallOptions
callback	PaginationCallback<protos.google.cloud.aiplatform.v1.IExportTensorboardTimeSeriesDataRequest, protos.google.cloud.aiplatform.v1.IExportTensorboardTimeSeriesDataResponse | null | undefined, protos.google.cloud.aiplatform.v1.ITimeSeriesDataPoint>

Returns
Type	Description
void

exportTensorboardTimeSeriesData(request, callback)

exportTensorboardTimeSeriesData(request: protos.google.cloud.aiplatform.v1.IExportTensorboardTimeSeriesDataRequest, callback: PaginationCallback<protos.google.cloud.aiplatform.v1.IExportTensorboardTimeSeriesDataRequest, protos.google.cloud.aiplatform.v1.IExportTensorboardTimeSeriesDataResponse | null | undefined, protos.google.cloud.aiplatform.v1.ITimeSeriesDataPoint>): void;

Parameters
Name	Description
request	IExportTensorboardTimeSeriesDataRequest
callback	PaginationCallback<protos.google.cloud.aiplatform.v1.IExportTensorboardTimeSeriesDataRequest, protos.google.cloud.aiplatform.v1.IExportTensorboardTimeSeriesDataResponse | null | undefined, protos.google.cloud.aiplatform.v1.ITimeSeriesDataPoint>

Returns
Type	Description
void

exportTensorboardTimeSeriesDataAsync(request, options)

exportTensorboardTimeSeriesDataAsync(request?: protos.google.cloud.aiplatform.v1.IExportTensorboardTimeSeriesDataRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.aiplatform.v1.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	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.v1.ITimeSeriesDataPoint>	{Object} An iterable Object that allows async iteration. 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 for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The resource name of the TensorboardTimeSeries to export data
   *  from. Format:
   *  `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeSeries/{time_series}`
   */
  // const tensorboardTimeSeries = 'abc123'
  /**
   *  Exports the TensorboardTimeSeries' data that match the filter expression.
   */
  // const filter = 'abc123'
  /**
   *  The maximum number of data points to return per page.
   *  The default page_size is 1000. Values must be between 1 and 10000.
   *  Values above 10000 are coerced to 10000.
   */
  // const pageSize = 1234
  /**
   *  A page token, received from a previous
   *  ExportTensorboardTimeSeriesData google.cloud.aiplatform.v1.TensorboardService.ExportTensorboardTimeSeriesData 
   *  call. Provide this to retrieve the subsequent page.
   *  When paginating, all other parameters provided to
   *  ExportTensorboardTimeSeriesData google.cloud.aiplatform.v1.TensorboardService.ExportTensorboardTimeSeriesData 
   *  must match the call that provided the page token.
   */
  // const pageToken = 'abc123'
  /**
   *  Field to use to sort the TensorboardTimeSeries' data.
   *  By default, TensorboardTimeSeries' data is returned in a pseudo random
   *  order.
   */
  // const orderBy = 'abc123'

  // Imports the Aiplatform library
  const {TensorboardServiceClient} = require('@google-cloud/aiplatform').v1;

  // Instantiates a client
  const aiplatformClient = new TensorboardServiceClient();

  async function callExportTensorboardTimeSeriesData() {
    // Construct request
    const request = {
      tensorboardTimeSeries,
    };

    // Run request
    const iterable = aiplatformClient.exportTensorboardTimeSeriesDataAsync(request);
    for await (const response of iterable) {
        console.log(response);
    }
  }

  callExportTensorboardTimeSeriesData();

exportTensorboardTimeSeriesDataStream(request, options)

exportTensorboardTimeSeriesDataStream(request?: protos.google.cloud.aiplatform.v1.IExportTensorboardTimeSeriesDataRequest, options?: CallOptions): Transform;

Equivalent to exportTensorboardTimeSeriesData, but returns a NodeJS Stream object.

Parameters
Name	Description
request	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 for more details and examples.

featureGroupPath(project, location, featureGroup)

featureGroupPath(project: string, location: string, featureGroup: string): string;

Return a fully-qualified featureGroup resource name string.

Parameters
Name	Description
project	string
location	string
featureGroup	string

Returns
Type	Description
string	{string} Resource name string.

featureOnlineStorePath(project, location, featureOnlineStore)

featureOnlineStorePath(project: string, location: string, featureOnlineStore: string): string;

Return a fully-qualified featureOnlineStore resource name string.

Parameters
Name	Description
project	string
location	string
featureOnlineStore	string

Returns
Type	Description
string	{string} Resource name string.

featurestorePath(project, location, featurestore)

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

Return a fully-qualified featurestore resource name string.

Parameters
Name	Description
project	string
location	string
featurestore	string

Returns
Type	Description
string	{string} Resource name string.

featureViewPath(project, location, featureOnlineStore, featureView)

featureViewPath(project: string, location: string, featureOnlineStore: string, featureView: string): string;

Return a fully-qualified featureView resource name string.

Parameters
Name	Description
project	string
location	string
featureOnlineStore	string
featureView	string

Returns
Type	Description
string	{string} Resource name string.

featureViewSyncPath(project, location, featureOnlineStore, featureView)

featureViewSyncPath(project: string, location: string, featureOnlineStore: string, featureView: string): string;

Return a fully-qualified featureViewSync resource name string.

Parameters
Name	Description
project	string
location	string
featureOnlineStore	string
featureView	string

Returns
Type	Description
string	{string} Resource name string.

getIamPolicy(request, options, callback)

getIamPolicy(request: IamProtos.google.iam.v1.GetIamPolicyRequest, options?: gax.CallOptions | Callback<IamProtos.google.iam.v1.Policy, IamProtos.google.iam.v1.GetIamPolicyRequest | null | undefined, {} | null | undefined>, callback?: Callback<IamProtos.google.iam.v1.Policy, IamProtos.google.iam.v1.GetIamPolicyRequest | null | undefined, {} | null | undefined>): Promise<[IamProtos.google.iam.v1.Policy]>;

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

Parameters
Name	Description
request	IamProtos.google.iam.v1.GetIamPolicyRequest The request object that will be sent.
options	CallOptions | Callback<google.iam.v1.Policy, google.iam.v1.GetIamPolicyRequest | null | undefined, {} | null | undefined> Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.
callback	Callback<google.iam.v1.Policy, google.iam.v1.GetIamPolicyRequest | null | undefined, {} | null | undefined> The function which will be called with the result of the API call. The second parameter to the callback is an object representing .

Returns
Type	Description
Promise<[google.iam.v1.Policy]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing . The promise has a method named "cancel" which cancels the ongoing API call.

getLocation(request, options, callback)

getLocation(request: LocationProtos.google.cloud.location.IGetLocationRequest, options?: gax.CallOptions | Callback<LocationProtos.google.cloud.location.ILocation, LocationProtos.google.cloud.location.IGetLocationRequest | null | undefined, {} | null | undefined>, callback?: Callback<LocationProtos.google.cloud.location.ILocation, LocationProtos.google.cloud.location.IGetLocationRequest | null | undefined, {} | null | undefined>): Promise<LocationProtos.google.cloud.location.ILocation>;

Gets information about a location.

Parameters
Name	Description
request	LocationProtos.google.cloud.location.IGetLocationRequest The request object that will be sent.
options	CallOptions | Callback<google.cloud.location.ILocation, google.cloud.location.IGetLocationRequest | null | undefined, {} | null | undefined> Call options. See CallOptions for more details.
callback	Callback<google.cloud.location.ILocation, google.cloud.location.IGetLocationRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
Promise<google.cloud.location.ILocation>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the documentation for more details and examples.

Example

const [response] = await client.getLocation(request);

getOperation(request, optionsOrCallback, callback)

getOperation(request: protos.google.longrunning.GetOperationRequest, optionsOrCallback?: gax.CallOptions | Callback<protos.google.longrunning.Operation, protos.google.longrunning.GetOperationRequest, {} | null | undefined>, callback?: Callback<protos.google.longrunning.Operation, protos.google.longrunning.GetOperationRequest, {} | null | undefined>): Promise<[protos.google.longrunning.Operation]>;

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

Parameters
Name	Description
request	GetOperationRequest The request object that will be sent.
optionsOrCallback	CallOptions | Callback<protos.google.longrunning.Operation, protos.google.longrunning.GetOperationRequest, {} | null | undefined>
callback	Callback<protos.google.longrunning.Operation, protos.google.longrunning.GetOperationRequest, {} | null | undefined> The function which will be called with the result of the API call. The second parameter to the callback is an object representing . {Promise} - The promise which resolves to an array. The first element of the array is an object representing . The promise has a method named "cancel" which cancels the ongoing API call.

Returns
Type	Description
Promise<[protos.google.longrunning.Operation]>

Example

const client = longrunning.operationsClient();
const name = '';
const [response] = await client.getOperation({name});
// doThingsWith(response)

getProjectId()

getProjectId(): Promise<string>;

Returns
Type	Description
Promise<string>

getProjectId(callback)

getProjectId(callback: Callback<string, undefined, undefined>): void;

Parameter
Name	Description
callback	Callback<string, undefined, undefined>

Returns
Type	Description
void

getTensorboard(request, options)

getTensorboard(request?: protos.google.cloud.aiplatform.v1.IGetTensorboardRequest, options?: CallOptions): Promise<[
        protos.google.cloud.aiplatform.v1.ITensorboard,
        protos.google.cloud.aiplatform.v1.IGetTensorboardRequest | undefined,
        {} | undefined
    ]>;

Gets a Tensorboard.

Parameters
Name	Description
request	IGetTensorboardRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
Promise<[ protos.google.cloud.aiplatform.v1.ITensorboard, protos.google.cloud.aiplatform.v1.IGetTensorboardRequest | undefined, {} | undefined ]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing Tensorboard. Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The name of the Tensorboard resource.
   *  Format:
   *  `projects/{project}/locations/{location}/tensorboards/{tensorboard}`
   */
  // const name = 'abc123'

  // Imports the Aiplatform library
  const {TensorboardServiceClient} = require('@google-cloud/aiplatform').v1;

  // Instantiates a client
  const aiplatformClient = new TensorboardServiceClient();

  async function callGetTensorboard() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const response = await aiplatformClient.getTensorboard(request);
    console.log(response);
  }

  callGetTensorboard();

getTensorboard(request, options, callback)

getTensorboard(request: protos.google.cloud.aiplatform.v1.IGetTensorboardRequest, options: CallOptions, callback: Callback<protos.google.cloud.aiplatform.v1.ITensorboard, protos.google.cloud.aiplatform.v1.IGetTensorboardRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IGetTensorboardRequest
options	CallOptions
callback	Callback<protos.google.cloud.aiplatform.v1.ITensorboard, protos.google.cloud.aiplatform.v1.IGetTensorboardRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

getTensorboard(request, callback)

getTensorboard(request: protos.google.cloud.aiplatform.v1.IGetTensorboardRequest, callback: Callback<protos.google.cloud.aiplatform.v1.ITensorboard, protos.google.cloud.aiplatform.v1.IGetTensorboardRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IGetTensorboardRequest
callback	Callback<protos.google.cloud.aiplatform.v1.ITensorboard, protos.google.cloud.aiplatform.v1.IGetTensorboardRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

getTensorboardExperiment(request, options)

getTensorboardExperiment(request?: protos.google.cloud.aiplatform.v1.IGetTensorboardExperimentRequest, options?: CallOptions): Promise<[
        protos.google.cloud.aiplatform.v1.ITensorboardExperiment,
        protos.google.cloud.aiplatform.v1.IGetTensorboardExperimentRequest | undefined,
        {} | undefined
    ]>;

Gets a TensorboardExperiment.

Parameters
Name	Description
request	IGetTensorboardExperimentRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
Promise<[ protos.google.cloud.aiplatform.v1.ITensorboardExperiment, protos.google.cloud.aiplatform.v1.IGetTensorboardExperimentRequest | undefined, {} | undefined ]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing TensorboardExperiment. Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The name of the TensorboardExperiment resource.
   *  Format:
   *  `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}`
   */
  // const name = 'abc123'

  // Imports the Aiplatform library
  const {TensorboardServiceClient} = require('@google-cloud/aiplatform').v1;

  // Instantiates a client
  const aiplatformClient = new TensorboardServiceClient();

  async function callGetTensorboardExperiment() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const response = await aiplatformClient.getTensorboardExperiment(request);
    console.log(response);
  }

  callGetTensorboardExperiment();

getTensorboardExperiment(request, options, callback)

getTensorboardExperiment(request: protos.google.cloud.aiplatform.v1.IGetTensorboardExperimentRequest, options: CallOptions, callback: Callback<protos.google.cloud.aiplatform.v1.ITensorboardExperiment, protos.google.cloud.aiplatform.v1.IGetTensorboardExperimentRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IGetTensorboardExperimentRequest
options	CallOptions
callback	Callback<protos.google.cloud.aiplatform.v1.ITensorboardExperiment, protos.google.cloud.aiplatform.v1.IGetTensorboardExperimentRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

getTensorboardExperiment(request, callback)

getTensorboardExperiment(request: protos.google.cloud.aiplatform.v1.IGetTensorboardExperimentRequest, callback: Callback<protos.google.cloud.aiplatform.v1.ITensorboardExperiment, protos.google.cloud.aiplatform.v1.IGetTensorboardExperimentRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IGetTensorboardExperimentRequest
callback	Callback<protos.google.cloud.aiplatform.v1.ITensorboardExperiment, protos.google.cloud.aiplatform.v1.IGetTensorboardExperimentRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

getTensorboardRun(request, options)

getTensorboardRun(request?: protos.google.cloud.aiplatform.v1.IGetTensorboardRunRequest, options?: CallOptions): Promise<[
        protos.google.cloud.aiplatform.v1.ITensorboardRun,
        protos.google.cloud.aiplatform.v1.IGetTensorboardRunRequest | undefined,
        {} | undefined
    ]>;

Gets a TensorboardRun.

Parameters
Name	Description
request	IGetTensorboardRunRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
Promise<[ protos.google.cloud.aiplatform.v1.ITensorboardRun, protos.google.cloud.aiplatform.v1.IGetTensorboardRunRequest | undefined, {} | undefined ]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing TensorboardRun. Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The name of the TensorboardRun resource.
   *  Format:
   *  `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}`
   */
  // const name = 'abc123'

  // Imports the Aiplatform library
  const {TensorboardServiceClient} = require('@google-cloud/aiplatform').v1;

  // Instantiates a client
  const aiplatformClient = new TensorboardServiceClient();

  async function callGetTensorboardRun() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const response = await aiplatformClient.getTensorboardRun(request);
    console.log(response);
  }

  callGetTensorboardRun();

getTensorboardRun(request, options, callback)

getTensorboardRun(request: protos.google.cloud.aiplatform.v1.IGetTensorboardRunRequest, options: CallOptions, callback: Callback<protos.google.cloud.aiplatform.v1.ITensorboardRun, protos.google.cloud.aiplatform.v1.IGetTensorboardRunRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IGetTensorboardRunRequest
options	CallOptions
callback	Callback<protos.google.cloud.aiplatform.v1.ITensorboardRun, protos.google.cloud.aiplatform.v1.IGetTensorboardRunRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

getTensorboardRun(request, callback)

getTensorboardRun(request: protos.google.cloud.aiplatform.v1.IGetTensorboardRunRequest, callback: Callback<protos.google.cloud.aiplatform.v1.ITensorboardRun, protos.google.cloud.aiplatform.v1.IGetTensorboardRunRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IGetTensorboardRunRequest
callback	Callback<protos.google.cloud.aiplatform.v1.ITensorboardRun, protos.google.cloud.aiplatform.v1.IGetTensorboardRunRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

getTensorboardTimeSeries(request, options)

getTensorboardTimeSeries(request?: protos.google.cloud.aiplatform.v1.IGetTensorboardTimeSeriesRequest, options?: CallOptions): Promise<[
        protos.google.cloud.aiplatform.v1.ITensorboardTimeSeries,
        protos.google.cloud.aiplatform.v1.IGetTensorboardTimeSeriesRequest | undefined,
        {} | undefined
    ]>;

Gets a TensorboardTimeSeries.

Parameters
Name	Description
request	IGetTensorboardTimeSeriesRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
Promise<[ protos.google.cloud.aiplatform.v1.ITensorboardTimeSeries, protos.google.cloud.aiplatform.v1.IGetTensorboardTimeSeriesRequest | undefined, {} | undefined ]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The name of the TensorboardTimeSeries resource.
   *  Format:
   *  `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeSeries/{time_series}`
   */
  // const name = 'abc123'

  // Imports the Aiplatform library
  const {TensorboardServiceClient} = require('@google-cloud/aiplatform').v1;

  // Instantiates a client
  const aiplatformClient = new TensorboardServiceClient();

  async function callGetTensorboardTimeSeries() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const response = await aiplatformClient.getTensorboardTimeSeries(request);
    console.log(response);
  }

  callGetTensorboardTimeSeries();

getTensorboardTimeSeries(request, options, callback)

getTensorboardTimeSeries(request: protos.google.cloud.aiplatform.v1.IGetTensorboardTimeSeriesRequest, options: CallOptions, callback: Callback<protos.google.cloud.aiplatform.v1.ITensorboardTimeSeries, protos.google.cloud.aiplatform.v1.IGetTensorboardTimeSeriesRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IGetTensorboardTimeSeriesRequest
options	CallOptions
callback	Callback<protos.google.cloud.aiplatform.v1.ITensorboardTimeSeries, protos.google.cloud.aiplatform.v1.IGetTensorboardTimeSeriesRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

getTensorboardTimeSeries(request, callback)

getTensorboardTimeSeries(request: protos.google.cloud.aiplatform.v1.IGetTensorboardTimeSeriesRequest, callback: Callback<protos.google.cloud.aiplatform.v1.ITensorboardTimeSeries, protos.google.cloud.aiplatform.v1.IGetTensorboardTimeSeriesRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IGetTensorboardTimeSeriesRequest
callback	Callback<protos.google.cloud.aiplatform.v1.ITensorboardTimeSeries, protos.google.cloud.aiplatform.v1.IGetTensorboardTimeSeriesRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

hyperparameterTuningJobPath(project, location, hyperparameterTuningJob)

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, location, indexEndpoint)

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, location, index)

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()

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.

listLocationsAsync(request, options)

listLocationsAsync(request: LocationProtos.google.cloud.location.IListLocationsRequest, options?: CallOptions): AsyncIterable<LocationProtos.google.cloud.location.ILocation>;

Lists information about the supported locations for this service. Returns an iterable object.

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

Parameters
Name	Description
request	LocationProtos.google.cloud.location.IListLocationsRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
AsyncIterable<google.cloud.location.ILocation>	{Object} An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing . 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 for more details and examples.

Example

const iterable = client.listLocationsAsync(request);
for await (const response of iterable) {
  // process response
}