Class v1beta1.EndpointServiceClient (6.2.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

A service for managing Vertex AI's Endpoints. v1beta1

Package

@google-cloud/aiplatform

Constructors

(constructor)(opts, gaxInstance)

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

Construct an instance of EndpointServiceClient.

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 EndpointServiceClient({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;

endpointServiceStub

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

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.

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.

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.

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: ''});

checkCreateEndpointProgress(name)

checkCreateEndpointProgress(name: string): Promise<LROperation<protos.google.cloud.aiplatform.v1beta1.Endpoint, protos.google.cloud.aiplatform.v1beta1.CreateEndpointOperationMetadata>>;

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

Parameter
Name	Description
name	string The operation name that will be passed.

Returns
Type	Description
Promise<LROperation<protos.google.cloud.aiplatform.v1beta1.Endpoint, protos.google.cloud.aiplatform.v1beta1.CreateEndpointOperationMetadata>>	{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 Endpoint in.
   *  Format: `projects/{project}/locations/{location}`
   */
  // const parent = 'abc123'
  /**
   *  Required. The Endpoint to create.
   */
  // const endpoint = {}
  /**
   *  Immutable. The ID to use for endpoint, which will become the final
   *  component of the endpoint resource name.
   *  If not provided, Vertex AI will generate a value for this ID.
   *  If the first character is a letter, this value may be up to 63 characters,
   *  and valid characters are `[a-z0-9-]`. The last character must be a letter
   *  or number.
   *  If the first character is a number, this value may be up to 9 characters,
   *  and valid characters are `[0-9]` with no leading zeros.
   *  When using HTTP/JSON, this field is populated
   *  based on a query string argument, such as `?endpoint_id=12345`. This is the
   *  fallback for fields that are not included in either the URI or the body.
   */
  // const endpointId = 'abc123'

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

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

  async function callCreateEndpoint() {
    // Construct request
    const request = {
      parent,
      endpoint,
      endpointId,
    };

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

  callCreateEndpoint();

checkDeleteEndpointProgress(name)

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

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

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 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 Endpoint resource to be deleted.
   *  Format:
   *  `projects/{project}/locations/{location}/endpoints/{endpoint}`
   */
  // const name = 'abc123'

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

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

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

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

  callDeleteEndpoint();

checkDeployModelProgress(name)

checkDeployModelProgress(name: string): Promise<LROperation<protos.google.cloud.aiplatform.v1beta1.DeployModelResponse, protos.google.cloud.aiplatform.v1beta1.DeployModelOperationMetadata>>;

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

Parameter
Name	Description
name	string The operation name that will be passed.

Returns
Type	Description
Promise<LROperation<protos.google.cloud.aiplatform.v1beta1.DeployModelResponse, protos.google.cloud.aiplatform.v1beta1.DeployModelOperationMetadata>>	{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 Endpoint resource into which to deploy a Model.
   *  Format:
   *  `projects/{project}/locations/{location}/endpoints/{endpoint}`
   */
  // const endpoint = 'abc123'
  /**
   *  Required. The DeployedModel to be created within the Endpoint. Note that
   *  Endpoint.traffic_split google.cloud.aiplatform.v1beta1.Endpoint.traffic_split 
   *  must be updated for the DeployedModel to start receiving traffic, either as
   *  part of this call, or via
   *  EndpointService.UpdateEndpoint google.cloud.aiplatform.v1beta1.EndpointService.UpdateEndpoint.
   */
  // const deployedModel = {}
  /**
   *  A map from a DeployedModel's ID to the percentage of this Endpoint's
   *  traffic that should be forwarded to that DeployedModel.
   *  If this field is non-empty, then the Endpoint's
   *  traffic_split google.cloud.aiplatform.v1beta1.Endpoint.traffic_split 
   *  will be overwritten with it. To refer to the ID of the just being deployed
   *  Model, a "0" should be used, and the actual ID of the new DeployedModel
   *  will be filled in its place by this method. The traffic percentage values
   *  must add up to 100.
   *  If this field is empty, then the Endpoint's
   *  traffic_split google.cloud.aiplatform.v1beta1.Endpoint.traffic_split  is
   *  not updated.
   */
  // const trafficSplit = [1,2,3,4]

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

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

  async function callDeployModel() {
    // Construct request
    const request = {
      endpoint,
      deployedModel,
    };

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

  callDeployModel();

checkMutateDeployedModelProgress(name)

checkMutateDeployedModelProgress(name: string): Promise<LROperation<protos.google.cloud.aiplatform.v1beta1.MutateDeployedModelResponse, protos.google.cloud.aiplatform.v1beta1.MutateDeployedModelOperationMetadata>>;

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

Parameter
Name	Description
name	string The operation name that will be passed.

Returns
Type	Description
Promise<LROperation<protos.google.cloud.aiplatform.v1beta1.MutateDeployedModelResponse, protos.google.cloud.aiplatform.v1beta1.MutateDeployedModelOperationMetadata>>	{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 Endpoint resource into which to mutate a
   *  DeployedModel. Format:
   *  `projects/{project}/locations/{location}/endpoints/{endpoint}`
   */
  // const endpoint = 'abc123'
  /**
   *  Required. The DeployedModel to be mutated within the Endpoint. Only the
   *  following fields can be mutated:
   *  * `min_replica_count` in either
   *  DedicatedResources google.cloud.aiplatform.v1beta1.DedicatedResources  or
   *  AutomaticResources google.cloud.aiplatform.v1beta1.AutomaticResources 
   *  * `max_replica_count` in either
   *  DedicatedResources google.cloud.aiplatform.v1beta1.DedicatedResources  or
   *  AutomaticResources google.cloud.aiplatform.v1beta1.AutomaticResources 
   *  * `required_replica_count` in
   *  DedicatedResources google.cloud.aiplatform.v1beta1.DedicatedResources 
   *  * autoscaling_metric_specs google.cloud.aiplatform.v1beta1.DedicatedResources.autoscaling_metric_specs 
   *  * `disable_container_logging` (v1 only)
   *  * `enable_container_logging` (v1beta1 only)
   */
  // const deployedModel = {}
  /**
   *  Required. The update mask applies to the resource. See
   *  google.protobuf.FieldMask google.protobuf.FieldMask.
   */
  // const updateMask = {}

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

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

  async function callMutateDeployedModel() {
    // Construct request
    const request = {
      endpoint,
      deployedModel,
      updateMask,
    };

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

  callMutateDeployedModel();

checkSetPublisherModelConfigProgress(name)

checkSetPublisherModelConfigProgress(name: string): Promise<LROperation<protos.google.cloud.aiplatform.v1beta1.PublisherModelConfig, protos.google.cloud.aiplatform.v1beta1.SetPublisherModelConfigOperationMetadata>>;

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

Parameter
Name	Description
name	string The operation name that will be passed.

Returns
Type	Description
Promise<LROperation<protos.google.cloud.aiplatform.v1beta1.PublisherModelConfig, protos.google.cloud.aiplatform.v1beta1.SetPublisherModelConfigOperationMetadata>>	{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 publisher model, in the format of
   *  `projects/{project}/locations/{location}/publishers/{publisher}/models/{model}`.
   */
  // const name = 'abc123'
  /**
   *  Required. The publisher model config.
   */
  // const publisherModelConfig = {}

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

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

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

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

  callSetPublisherModelConfig();

checkUndeployModelProgress(name)

checkUndeployModelProgress(name: string): Promise<LROperation<protos.google.cloud.aiplatform.v1beta1.UndeployModelResponse, protos.google.cloud.aiplatform.v1beta1.UndeployModelOperationMetadata>>;

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

Parameter
Name	Description
name	string The operation name that will be passed.

Returns
Type	Description
Promise<LROperation<protos.google.cloud.aiplatform.v1beta1.UndeployModelResponse, protos.google.cloud.aiplatform.v1beta1.UndeployModelOperationMetadata>>	{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 Endpoint resource from which to undeploy a Model.
   *  Format:
   *  `projects/{project}/locations/{location}/endpoints/{endpoint}`
   */
  // const endpoint = 'abc123'
  /**
   *  Required. The ID of the DeployedModel to be undeployed from the Endpoint.
   */
  // const deployedModelId = 'abc123'
  /**
   *  If this field is provided, then the Endpoint's
   *  traffic_split google.cloud.aiplatform.v1beta1.Endpoint.traffic_split 
   *  will be overwritten with it. If last DeployedModel is being undeployed from
   *  the Endpoint, the Endpoint.traffic_split  will always end up empty when
   *  this call returns. A DeployedModel will be successfully undeployed only if
   *  it doesn't have any traffic assigned to it when this method executes, or if
   *  this field unassigns any traffic to it.
   */
  // const trafficSplit = [1,2,3,4]

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

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

  async function callUndeployModel() {
    // Construct request
    const request = {
      endpoint,
      deployedModelId,
    };

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

  callUndeployModel();

checkUpdateEndpointLongRunningProgress(name)

checkUpdateEndpointLongRunningProgress(name: string): Promise<LROperation<protos.google.cloud.aiplatform.v1beta1.Endpoint, protos.google.cloud.aiplatform.v1beta1.UpdateEndpointOperationMetadata>>;

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

Parameter
Name	Description
name	string The operation name that will be passed.

Returns
Type	Description
Promise<LROperation<protos.google.cloud.aiplatform.v1beta1.Endpoint, protos.google.cloud.aiplatform.v1beta1.UpdateEndpointOperationMetadata>>	{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 Endpoint which replaces the resource on the server. Currently
   *  we only support updating the `client_connection_config` field, all the
   *  other fields' update will be blocked.
   */
  // const endpoint = {}

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

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

  async function callUpdateEndpointLongRunning() {
    // Construct request
    const request = {
      endpoint,
    };

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

  callUpdateEndpointLongRunning();

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.

createEndpoint(request, options)

createEndpoint(request?: protos.google.cloud.aiplatform.v1beta1.ICreateEndpointRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.aiplatform.v1beta1.IEndpoint, protos.google.cloud.aiplatform.v1beta1.ICreateEndpointOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Creates an Endpoint.

Parameters
Name	Description
request	ICreateEndpointRequest 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.v1beta1.IEndpoint, protos.google.cloud.aiplatform.v1beta1.ICreateEndpointOperationMetadata>, 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 Endpoint in.
   *  Format: `projects/{project}/locations/{location}`
   */
  // const parent = 'abc123'
  /**
   *  Required. The Endpoint to create.
   */
  // const endpoint = {}
  /**
   *  Immutable. The ID to use for endpoint, which will become the final
   *  component of the endpoint resource name.
   *  If not provided, Vertex AI will generate a value for this ID.
   *  If the first character is a letter, this value may be up to 63 characters,
   *  and valid characters are `[a-z0-9-]`. The last character must be a letter
   *  or number.
   *  If the first character is a number, this value may be up to 9 characters,
   *  and valid characters are `[0-9]` with no leading zeros.
   *  When using HTTP/JSON, this field is populated
   *  based on a query string argument, such as `?endpoint_id=12345`. This is the
   *  fallback for fields that are not included in either the URI or the body.
   */
  // const endpointId = 'abc123'

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

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

  async function callCreateEndpoint() {
    // Construct request
    const request = {
      parent,
      endpoint,
      endpointId,
    };

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

  callCreateEndpoint();

createEndpoint(request, options, callback)

createEndpoint(request: protos.google.cloud.aiplatform.v1beta1.ICreateEndpointRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.aiplatform.v1beta1.IEndpoint, protos.google.cloud.aiplatform.v1beta1.ICreateEndpointOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	ICreateEndpointRequest
options	CallOptions
callback	Callback<LROperation<protos.google.cloud.aiplatform.v1beta1.IEndpoint, protos.google.cloud.aiplatform.v1beta1.ICreateEndpointOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>

Returns
Type	Description
void

createEndpoint(request, callback)

createEndpoint(request: protos.google.cloud.aiplatform.v1beta1.ICreateEndpointRequest, callback: Callback<LROperation<protos.google.cloud.aiplatform.v1beta1.IEndpoint, protos.google.cloud.aiplatform.v1beta1.ICreateEndpointOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	ICreateEndpointRequest
callback	Callback<LROperation<protos.google.cloud.aiplatform.v1beta1.IEndpoint, protos.google.cloud.aiplatform.v1beta1.ICreateEndpointOperationMetadata>, protos.google.longrunning.IOperation | 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.

deleteEndpoint(request, options)

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

Deletes an Endpoint.

Parameters
Name	Description
request	IDeleteEndpointRequest 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.v1beta1.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 Endpoint resource to be deleted.
   *  Format:
   *  `projects/{project}/locations/{location}/endpoints/{endpoint}`
   */
  // const name = 'abc123'

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

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

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

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

  callDeleteEndpoint();

deleteEndpoint(request, options, callback)

deleteEndpoint(request: protos.google.cloud.aiplatform.v1beta1.IDeleteEndpointRequest, 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	IDeleteEndpointRequest
options	CallOptions
callback	Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.aiplatform.v1beta1.IDeleteOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>

Returns
Type	Description
void

deleteEndpoint(request, callback)

deleteEndpoint(request: protos.google.cloud.aiplatform.v1beta1.IDeleteEndpointRequest, 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	IDeleteEndpointRequest
callback	Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.aiplatform.v1beta1.IDeleteOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>

Returns
Type	Description
void

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: ''});

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.

deployModel(request, options)

deployModel(request?: protos.google.cloud.aiplatform.v1beta1.IDeployModelRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.aiplatform.v1beta1.IDeployModelResponse, protos.google.cloud.aiplatform.v1beta1.IDeployModelOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Deploys a Model into this Endpoint, creating a DeployedModel within it.

Parameters
Name	Description
request	IDeployModelRequest 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.v1beta1.IDeployModelResponse, protos.google.cloud.aiplatform.v1beta1.IDeployModelOperationMetadata>, 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 Endpoint resource into which to deploy a Model.
   *  Format:
   *  `projects/{project}/locations/{location}/endpoints/{endpoint}`
   */
  // const endpoint = 'abc123'
  /**
   *  Required. The DeployedModel to be created within the Endpoint. Note that
   *  Endpoint.traffic_split google.cloud.aiplatform.v1beta1.Endpoint.traffic_split 
   *  must be updated for the DeployedModel to start receiving traffic, either as
   *  part of this call, or via
   *  EndpointService.UpdateEndpoint google.cloud.aiplatform.v1beta1.EndpointService.UpdateEndpoint.
   */
  // const deployedModel = {}
  /**
   *  A map from a DeployedModel's ID to the percentage of this Endpoint's
   *  traffic that should be forwarded to that DeployedModel.
   *  If this field is non-empty, then the Endpoint's
   *  traffic_split google.cloud.aiplatform.v1beta1.Endpoint.traffic_split 
   *  will be overwritten with it. To refer to the ID of the just being deployed
   *  Model, a "0" should be used, and the actual ID of the new DeployedModel
   *  will be filled in its place by this method. The traffic percentage values
   *  must add up to 100.
   *  If this field is empty, then the Endpoint's
   *  traffic_split google.cloud.aiplatform.v1beta1.Endpoint.traffic_split  is
   *  not updated.
   */
  // const trafficSplit = [1,2,3,4]

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

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

  async function callDeployModel() {
    // Construct request
    const request = {
      endpoint,
      deployedModel,
    };

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

  callDeployModel();

deployModel(request, options, callback)

deployModel(request: protos.google.cloud.aiplatform.v1beta1.IDeployModelRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.aiplatform.v1beta1.IDeployModelResponse, protos.google.cloud.aiplatform.v1beta1.IDeployModelOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IDeployModelRequest
options	CallOptions
callback	Callback<LROperation<protos.google.cloud.aiplatform.v1beta1.IDeployModelResponse, protos.google.cloud.aiplatform.v1beta1.IDeployModelOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>

Returns
Type	Description
void

deployModel(request, callback)

deployModel(request: protos.google.cloud.aiplatform.v1beta1.IDeployModelRequest, callback: Callback<LROperation<protos.google.cloud.aiplatform.v1beta1.IDeployModelResponse, protos.google.cloud.aiplatform.v1beta1.IDeployModelOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IDeployModelRequest
callback	Callback<LROperation<protos.google.cloud.aiplatform.v1beta1.IDeployModelResponse, protos.google.cloud.aiplatform.v1beta1.IDeployModelOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>

Returns
Type	Description
void

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.

exampleStorePath(project, location, exampleStore)

exampleStorePath(project: string, location: string, exampleStore: string): string;

Return a fully-qualified exampleStore resource name string.

Parameters
Name	Description
project	string
location	string
exampleStore	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.

extensionPath(project, location, extension)

extensionPath(project: string, location: string, extension: string): string;

Return a fully-qualified extension resource name string.

Parameters
Name	Description
project	string
location	string
extension	string

Returns
Type	Description
string	{string} Resource name string.

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.

featureMonitorJobPath(project, location, featureGroup, featureMonitor, featureMonitorJob)

featureMonitorJobPath(project: string, location: string, featureGroup: string, featureMonitor: string, featureMonitorJob: string): string;

Return a fully-qualified featureMonitorJob resource name string.

Parameters
Name	Description
project	string
location	string
featureGroup	string
featureMonitor	string
featureMonitorJob	string

Returns
Type	Description
string	{string} Resource name string.

featureMonitorPath(project, location, featureGroup, featureMonitor)

featureMonitorPath(project: string, location: string, featureGroup: string, featureMonitor: string): string;

Return a fully-qualified featureMonitor resource name string.

Parameters
Name	Description
project	string
location	string
featureGroup	string
featureMonitor	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.

fetchPublisherModelConfig(request, options)

fetchPublisherModelConfig(request?: protos.google.cloud.aiplatform.v1beta1.IFetchPublisherModelConfigRequest, options?: CallOptions): Promise<[
        protos.google.cloud.aiplatform.v1beta1.IPublisherModelConfig,
        protos.google.cloud.aiplatform.v1beta1.IFetchPublisherModelConfigRequest | undefined,
        {} | undefined
    ]>;

Fetches the configs of publisher models.

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

Returns
Type	Description
Promise<[ protos.google.cloud.aiplatform.v1beta1.IPublisherModelConfig, protos.google.cloud.aiplatform.v1beta1.IFetchPublisherModelConfigRequest | undefined, {} | undefined ]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing PublisherModelConfig. 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 publisher model, in the format of
   *  `projects/{project}/locations/{location}/publishers/{publisher}/models/{model}`.
   */
  // const name = 'abc123'

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

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

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

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

  callFetchPublisherModelConfig();

fetchPublisherModelConfig(request, options, callback)

fetchPublisherModelConfig(request: protos.google.cloud.aiplatform.v1beta1.IFetchPublisherModelConfigRequest, options: CallOptions, callback: Callback<protos.google.cloud.aiplatform.v1beta1.IPublisherModelConfig, protos.google.cloud.aiplatform.v1beta1.IFetchPublisherModelConfigRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IFetchPublisherModelConfigRequest
options	CallOptions
callback	Callback<protos.google.cloud.aiplatform.v1beta1.IPublisherModelConfig, protos.google.cloud.aiplatform.v1beta1.IFetchPublisherModelConfigRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

fetchPublisherModelConfig(request, callback)

fetchPublisherModelConfig(request: protos.google.cloud.aiplatform.v1beta1.IFetchPublisherModelConfigRequest, callback: Callback<protos.google.cloud.aiplatform.v1beta1.IPublisherModelConfig, protos.google.cloud.aiplatform.v1beta1.IFetchPublisherModelConfigRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IFetchPublisherModelConfigRequest
callback	Callback<protos.google.cloud.aiplatform.v1beta1.IPublisherModelConfig, protos.google.cloud.aiplatform.v1beta1.IFetchPublisherModelConfigRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

getEndpoint(request, options)

getEndpoint(request?: protos.google.cloud.aiplatform.v1beta1.IGetEndpointRequest, options?: CallOptions): Promise<[
        protos.google.cloud.aiplatform.v1beta1.IEndpoint,
        protos.google.cloud.aiplatform.v1beta1.IGetEndpointRequest | undefined,
        {} | undefined
    ]>;

Gets an Endpoint.

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

Returns
Type	Description
Promise<[ protos.google.cloud.aiplatform.v1beta1.IEndpoint, protos.google.cloud.aiplatform.v1beta1.IGetEndpointRequest | undefined, {} | undefined ]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing Endpoint. 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 Endpoint resource.
   *  Format:
   *  `projects/{project}/locations/{location}/endpoints/{endpoint}`
   */
  // const name = 'abc123'

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

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

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

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

  callGetEndpoint();

getEndpoint(request, options, callback)

getEndpoint(request: protos.google.cloud.aiplatform.v1beta1.IGetEndpointRequest, options: CallOptions, callback: Callback<protos.google.cloud.aiplatform.v1beta1.IEndpoint, protos.google.cloud.aiplatform.v1beta1.IGetEndpointRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IGetEndpointRequest
options	CallOptions
callback	Callback<protos.google.cloud.aiplatform.v1beta1.IEndpoint, protos.google.cloud.aiplatform.v1beta1.IGetEndpointRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

getEndpoint(request, callback)

getEndpoint(request: protos.google.cloud.aiplatform.v1beta1.IGetEndpointRequest, callback: Callback<protos.google.cloud.aiplatform.v1beta1.IEndpoint, protos.google.cloud.aiplatform.v1beta1.IGetEndpointRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IGetEndpointRequest
callback	Callback<protos.google.cloud.aiplatform.v1beta1.IEndpoint, protos.google.cloud.aiplatform.v1beta1.IGetEndpointRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

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

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.

listEndpoints(request, options)

listEndpoints(request?: protos.google.cloud.aiplatform.v1beta1.IListEndpointsRequest, options?: CallOptions): Promise<[
        protos.google.cloud.aiplatform.v1beta1.IEndpoint[],
        protos.google.cloud.aiplatform.v1beta1.IListEndpointsRequest | null,
        protos.google.cloud.aiplatform.v1beta1.IListEndpointsResponse
    ]>;

Lists Endpoints in a Location.

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

Returns
Type	Description
Promise<[ protos.google.cloud.aiplatform.v1beta1.IEndpoint[], protos.google.cloud.aiplatform.v1beta1.IListEndpointsRequest | null, protos.google.cloud.aiplatform.v1beta1.IListEndpointsResponse ]>	{Promise} - The promise which resolves to an array. The first element of the array is Array of Endpoint. 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 listEndpointsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listEndpoints(request, options, callback)

listEndpoints(request: protos.google.cloud.aiplatform.v1beta1.IListEndpointsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.aiplatform.v1beta1.IListEndpointsRequest, protos.google.cloud.aiplatform.v1beta1.IListEndpointsResponse | null | undefined, protos.google.cloud.aiplatform.v1beta1.IEndpoint>): void;

Parameters
Name	Description
request	IListEndpointsRequest
options	CallOptions
callback	PaginationCallback<protos.google.cloud.aiplatform.v1beta1.IListEndpointsRequest, protos.google.cloud.aiplatform.v1beta1.IListEndpointsResponse | null | undefined, protos.google.cloud.aiplatform.v1beta1.IEndpoint>

Returns
Type	Description
void

listEndpoints(request, callback)

listEndpoints(request: protos.google.cloud.aiplatform.v1beta1.IListEndpointsRequest, callback: PaginationCallback<protos.google.cloud.aiplatform.v1beta1.IListEndpointsRequest, protos.google.cloud.aiplatform.v1beta1.IListEndpointsResponse | null | undefined, protos.google.cloud.aiplatform.v1beta1.IEndpoint>): void;

Parameters
Name	Description
request	IListEndpointsRequest
callback	PaginationCallback<protos.google.cloud.aiplatform.v1beta1.IListEndpointsRequest, protos.google.cloud.aiplatform.v1beta1.IListEndpointsResponse | null | undefined, protos.google.cloud.aiplatform.v1beta1.IEndpoint>

Returns
Type	Description
void

listEndpointsAsync(request, options)

listEndpointsAsync(request?: protos.google.cloud.aiplatform.v1beta1.IListEndpointsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.aiplatform.v1beta1.IEndpoint>;

Equivalent to listEndpoints, but returns an iterable object.

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

Parameters
Name	Description
request	IListEndpointsRequest 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.IEndpoint>	{Object} An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing Endpoint. 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 Location from which to list the
   *  Endpoints. Format: `projects/{project}/locations/{location}`
   */
  // const parent = 'abc123'
  /**
   *  Optional. An expression for filtering the results of the request. For field
   *  names both snake_case and camelCase are supported.
   *    * `endpoint` supports `=` and `!=`. `endpoint` represents the Endpoint
   *      ID, i.e. the last segment of the Endpoint's
   *      resource name google.cloud.aiplatform.v1beta1.Endpoint.name.
   *    * `display_name` supports `=` and `!=`.
   *    * `labels` supports general map functions that is:
   *      * `labels.key=value` - key:value equality
   *      * `labels.key:*` or `labels:key` - key existence
   *      * A key including a space must be quoted. `labels."a key"`.
   *    * `base_model_name` only supports `=`.
   *  Some examples:
   *    * `endpoint=1`
   *    * `displayName="myDisplayName"`
   *    * `labels.myKey="myValue"`
   *    * `baseModelName="text-bison"`
   */
  // const filter = 'abc123'
  /**
   *  Optional. The standard list page size.
   */
  // const pageSize = 1234
  /**
   *  Optional. The standard list page token.
   *  Typically obtained via
   *  ListEndpointsResponse.next_page_token google.cloud.aiplatform.v1beta1.ListEndpointsResponse.next_page_token 
   *  of the previous
   *  EndpointService.ListEndpoints google.cloud.aiplatform.v1beta1.EndpointService.ListEndpoints 
   *  call.
   */
  // const pageToken = 'abc123'
  /**
   *  Optional. Mask specifying which fields to read.
   */
  // const readMask = {}

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

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

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

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

  callListEndpoints();

listEndpointsStream(request, options)

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

Equivalent to listEndpoints, but returns a NodeJS Stream object.

Parameters
Name	Description
request	IListEndpointsRequest 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 Endpoint 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 listEndpointsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

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
}

listOperationsAsync(request, options)

listOperationsAsync(request: protos.google.longrunning.ListOperationsRequest, options?: gax.CallOptions): AsyncIterable<protos.google.longrunning.IOperation>;

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED. Returns an iterable object.

For-await-of syntax is used with the iterable to recursively get response element on-demand.

Parameters
Name	Description
request	ListOperationsRequest The request object that will be sent.
options	CallOptions Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.

Returns
Type	Description
AsyncIterable<protos.google.longrunning.IOperation>	{Object} An iterable Object that conforms to iteration protocols.

Example

const client = longrunning.operationsClient();
for await (const response of client.listOperationsAsync(request));
// doThingsWith(response)

locationPath(project, location)

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)

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)

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)

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)

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.

matchCachedContentFromCachedContentName(cachedContentName)

matchCachedContentFromCachedContentName(cachedContentName: string): string | number;

Parse the cached_content from CachedContent resource.

Parameter
Name	Description
cachedContentName	string A fully-qualified path representing CachedContent resource.

Returns
Type	Description
string | number	{string} A string representing the cached_content.

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)

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)

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)

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)

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)

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)

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)

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)

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.

matchDatasetFromDatasetVersionName(datasetVersionName)

matchDatasetFromDatasetVersionName(datasetVersionName: string): string | number;

Parse the dataset from DatasetVersion resource.

Parameter
Name	Description
datasetVersionName	string A fully-qualified path representing DatasetVersion resource.

Returns
Type	Description
string | number	{string} A string representing the dataset.

matchDatasetFromSavedQueryName(savedQueryName)

matchDatasetFromSavedQueryName(savedQueryName: string): string | number;

Parse the dataset from SavedQuery resource.

Parameter
Name	Description
savedQueryName	string A fully-qualified path representing SavedQuery resource.

Returns
Type	Description
string | number	{string} A string representing the dataset.

matchDatasetVersionFromDatasetVersionName(datasetVersionName)

matchDatasetVersionFromDatasetVersionName(datasetVersionName: string): string | number;

Parse the dataset_version from DatasetVersion resource.

Parameter
Name	Description
datasetVersionName	string A fully-qualified path representing DatasetVersion resource.

Returns
Type	Description
string | number	{string} A string representing the dataset_version.

matchDeploymentResourcePoolFromDeploymentResourcePoolName(deploymentResourcePoolName)

matchDeploymentResourcePoolFromDeploymentResourcePoolName(deploymentResourcePoolName: string): string | number;

Parse the deployment_resource_pool from DeploymentResourcePool resource.

Parameter
Name	Description
deploymentResourcePoolName	string A fully-qualified path representing DeploymentResourcePool resource.

Returns
Type	Description
string | number	{string} A string representing the deployment_resource_pool.

matchEndpointFromProjectLocationEndpointName(projectLocationEndpointName)

matchEndpointFromProjectLocationEndpointName(projectLocationEndpointName: string): string | number;

Parse the endpoint from ProjectLocationEndpoint resource.

Parameter
Name	Description
projectLocationEndpointName	string A fully-qualified path representing project_location_endpoint resource.

Returns
Type	Description
string | number	{string} A string representing the endpoint.

matchEntityTypeFromEntityTypeName(entityTypeName)

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.

matchEntityTypeFromProjectLocationFeaturestoreEntityTypeFeaturesName(projectLocationFeaturestoreEntityTypeFeaturesName)

matchEntityTypeFromProjectLocationFeaturestoreEntityTypeFeaturesName(projectLocationFeaturestoreEntityTypeFeaturesName: string): string | number;

Parse the entity_type from ProjectLocationFeaturestoreEntityTypeFeatures resource.

Parameter
Name	Description
projectLocationFeaturestoreEntityTypeFeaturesName	string A fully-qualified path representing project_location_featurestore_entity_type_features resource.

Returns
Type	Description
string | number	{string} A string representing the entity_type.

matchEvaluationFromModelEvaluationName(modelEvaluationName)

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)

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.

matchEventFromSessionEventName(sessionEventName)

matchEventFromSessionEventName(sessionEventName: string): string | number;

Parse the event from SessionEvent resource.

Parameter
Name	Description
sessionEventName	string A fully-qualified path representing SessionEvent resource.

Returns
Type	Description
string | number	{string} A string representing the event.

matchExampleStoreFromExampleStoreName(exampleStoreName)

matchExampleStoreFromExampleStoreName(exampleStoreName: string): string | number;

Parse the example_store from ExampleStore resource.

Parameter
Name	Description
exampleStoreName	string A fully-qualified path representing ExampleStore resource.

Returns
Type	Description
string | number	{string} A string representing the example_store.

matchExecutionFromExecutionName(executionName)

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)

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)

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)

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.

matchExtensionFromExtensionName(extensionName)

matchExtensionFromExtensionName(extensionName: string): string | number;

Parse the extension from Extension resource.

Parameter
Name	Description
extensionName	string A fully-qualified path representing Extension resource.

Returns
Type	Description
string | number	{string} A string representing the extension.

matchFeatureFromProjectLocationFeatureGroupFeaturesName(projectLocationFeatureGroupFeaturesName)

matchFeatureFromProjectLocationFeatureGroupFeaturesName(projectLocationFeatureGroupFeaturesName: string): string | number;

Parse the feature from ProjectLocationFeatureGroupFeatures resource.

Parameter
Name	Description
projectLocationFeatureGroupFeaturesName	string A fully-qualified path representing project_location_feature_group_features resource.

Returns
Type	Description
string | number	{string} A string representing the feature.

matchFeatureFromProjectLocationFeaturestoreEntityTypeFeaturesName(projectLocationFeaturestoreEntityTypeFeaturesName)

matchFeatureFromProjectLocationFeaturestoreEntityTypeFeaturesName(projectLocationFeaturestoreEntityTypeFeaturesName: string): string | number;

Parse the feature from ProjectLocationFeaturestoreEntityTypeFeatures resource.

Parameter
Name	Description
projectLocationFeaturestoreEntityTypeFeaturesName	string A fully-qualified path representing project_location_featurestore_entity_type_features resource.

Returns
Type	Description
string | number	{string} A string representing the feature.

matchFeatureGroupFromFeatureGroupName(featureGroupName)

matchFeatureGroupFromFeatureGroupName(featureGroupName: string): string | number;

Parse the feature_group from FeatureGroup resource.

Parameter
Name	Description
featureGroupName	string A fully-qualified path representing FeatureGroup resource.

Returns
Type	Description
string | number	{string} A string representing the feature_group.

matchFeatureGroupFromFeatureMonitorJobName(featureMonitorJobName)

matchFeatureGroupFromFeatureMonitorJobName(featureMonitorJobName: string): string | number;

Parse the feature_group from FeatureMonitorJob resource.

Parameter
Name	Description
featureMonitorJobName	string A fully-qualified path representing FeatureMonitorJob resource.

Returns
Type	Description
string | number	{string} A string representing the feature_group.

matchFeatureGroupFromFeatureMonitorName(featureMonitorName)

matchFeatureGroupFromFeatureMonitorName(featureMonitorName: string): string | number;

Parse the feature_group from FeatureMonitor resource.

Parameter
Name	Description
featureMonitorName	string A fully-qualified path representing FeatureMonitor resource.

Returns
Type	Description
string | number	{string} A string representing the feature_group.

matchFeatureGroupFromProjectLocationFeatureGroupFeaturesName(projectLocationFeatureGroupFeaturesName)

matchFeatureGroupFromProjectLocationFeatureGroupFeaturesName(projectLocationFeatureGroupFeaturesName: string): string | number;

Parse the feature_group from ProjectLocationFeatureGroupFeatures resource.

Parameter
Name	Description
projectLocationFeatureGroupFeaturesName	string A fully-qualified path representing project_location_feature_group_features resource.

Returns
Type	Description
string | number	{string} A string representing the feature_group.

matchFeatureMonitorFromFeatureMonitorJobName(featureMonitorJobName)

matchFeatureMonitorFromFeatureMonitorJobName(featureMonitorJobName: string): string | number;

Parse the feature_monitor from FeatureMonitorJob resource.

Parameter
Name	Description
featureMonitorJobName	string A fully-qualified path representing FeatureMonitorJob resource.

Returns
Type	Description
string | number	{string} A string representing the feature_monitor.

matchFeatureMonitorFromFeatureMonitorName(featureMonitorName)

matchFeatureMonitorFromFeatureMonitorName(featureMonitorName: string): string | number;

Parse the feature_monitor from FeatureMonitor resource.

Parameter
Name	Description
featureMonitorName	string A fully-qualified path representing FeatureMonitor resource.

Returns
Type	Description
string | number	{string} A string representing the feature_monitor.

matchFeatureMonitorJobFromFeatureMonitorJobName(featureMonitorJobName)

matchFeatureMonitorJobFromFeatureMonitorJobName(featureMonitorJobName: string): string | number;

Parse the feature_monitor_job from FeatureMonitorJob resource.

Parameter
Name	Description
featureMonitorJobName	string A fully-qualified path representing FeatureMonitorJob resource.

Returns
Type	Description
string | number	{string} A string representing the feature_monitor_job.

matchFeatureOnlineStoreFromFeatureOnlineStoreName(featureOnlineStoreName)

matchFeatureOnlineStoreFromFeatureOnlineStoreName(featureOnlineStoreName: string): string | number;

Parse the feature_online_store from FeatureOnlineStore resource.

Parameter
Name	Description
featureOnlineStoreName	string A fully-qualified path representing FeatureOnlineStore resource.

Returns
Type	Description
string | number	{string} A string representing the feature_online_store.

matchFeatureOnlineStoreFromFeatureViewName(featureViewName)

matchFeatureOnlineStoreFromFeatureViewName(featureViewName: string): string | number;

Parse the feature_online_store from FeatureView resource.

Parameter
Name	Description
featureViewName	string A fully-qualified path representing FeatureView resource.

Returns
Type	Description
string | number	{string} A string representing the feature_online_store.

matchFeatureOnlineStoreFromFeatureViewSyncName(featureViewSyncName)

matchFeatureOnlineStoreFromFeatureViewSyncName(featureViewSyncName: string): string | number;

Parse the feature_online_store from FeatureViewSync resource.

Parameter
Name	Description
featureViewSyncName	string A fully-qualified path representing FeatureViewSync resource.

Returns
Type	Description
string | number	{string} A string representing the feature_online_store.

matchFeaturestoreFromEntityTypeName(entityTypeName)

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.

matchFeaturestoreFromFeaturestoreName(featurestoreName)

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.

matchFeaturestoreFromProjectLocationFeaturestoreEntityTypeFeaturesName(projectLocationFeaturestoreEntityTypeFeaturesName)

matchFeaturestoreFromProjectLocationFeaturestoreEntityTypeFeaturesName(projectLocationFeaturestoreEntityTypeFeaturesName: string): string | number;

Parse the featurestore from ProjectLocationFeaturestoreEntityTypeFeatures resource.

Parameter
Name	Description
projectLocationFeaturestoreEntityTypeFeaturesName	string A fully-qualified path representing project_location_featurestore_entity_type_features resource.

Returns
Type	Description
string | number	{string} A string representing the featurestore.

matchFeatureViewFromFeatureViewName(featureViewName)

matchFeatureViewFromFeatureViewName(featureViewName: string): string | number;

Parse the feature_view from FeatureView resource.

Parameter
Name	Description
featureViewName	string A fully-qualified path representing FeatureView resource.

Returns
Type	Description
string | number	{string} A string representing the feature_view.

matchFeatureViewFromFeatureViewSyncName(featureViewSyncName)

matchFeatureViewFromFeatureViewSyncName(featureViewSyncName: string): string | number;

Parse the feature_view from FeatureViewSync resource.

Parameter
Name	Description
featureViewSyncName	string A fully-qualified path representing FeatureViewSync resource.

Returns
Type	Description
string | number	{string} A string representing the feature_view.

matchHyperparameterTuningJobFromHyperparameterTuningJobName(hyperparameterTuningJobName)

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)

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)

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)

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)

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)

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)

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.

matchLocationFromCachedContentName(cachedContentName)

matchLocationFromCachedContentName(cachedContentName: string): string | number;

Parse the location from CachedContent resource.

Parameter
Name	Description
cachedContentName	string A fully-qualified path representing CachedContent 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)

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)

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)

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)

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.

matchLocationFromDatasetVersionName(datasetVersionName)

matchLocationFromDatasetVersionName(datasetVersionName: string): string | number;

Parse the location from DatasetVersion resource.

Parameter
Name	Description
datasetVersionName	string A fully-qualified path representing DatasetVersion resource.

Returns
Type	Description
string | number	{string} A string representing the location.

matchLocationFromDeploymentResourcePoolName(deploymentResourcePoolName)

matchLocationFromDeploymentResourcePoolName(deploymentResourcePoolName: string): string | number;

Parse the location from DeploymentResourcePool resource.

Parameter
Name	Description
deploymentResourcePoolName	string A fully-qualified path representing DeploymentResourcePool resource.

Returns
Type	Description
string | number	{string} A string representing the location.

matchLocationFromEntityTypeName(entityTypeName)

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.

matchLocationFromExampleStoreName(exampleStoreName)

matchLocationFromExampleStoreName(exampleStoreName: string): string | number;

Parse the location from ExampleStore resource.

Parameter
Name	Description
exampleStoreName	string A fully-qualified path representing ExampleStore resource.

Returns
Type	Description
string | number	{string} A string representing the location.

matchLocationFromExecutionName(executionName)

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.

matchLocationFromExtensionName(extensionName)

matchLocationFromExtensionName(extensionName: string): string | number;

Parse the location from Extension resource.

Parameter
Name	Description
extensionName	string A fully-qualified path representing Extension resource.

Returns
Type	Description
string | number	{string} A string representing the location.

matchLocationFromFeatureGroupName(featureGroupName)

matchLocationFromFeatureGroupName(featureGroupName: string): string | number;

Parse the location from FeatureGroup resource.

Parameter
Name	Description
featureGroupName	string A fully-qualified path representing FeatureGroup resource.

Returns
Type	Description
string | number	{string} A string representing the location.

matchLocationFromFeatureMonitorJobName(featureMonitorJobName)

matchLocationFromFeatureMonitorJobName(featureMonitorJobName: string): string | number;

Parse the location from FeatureMonitorJob resource.

Parameter
Name	Description
featureMonitorJobName	string A fully-qualified path representing FeatureMonitorJob resource.

Returns
Type	Description
string | number	{string} A string representing the location.

matchLocationFromFeatureMonitorName(featureMonitorName)

matchLocationFromFeatureMonitorName(featureMonitorName: string): string | number;

Parse the location from FeatureMonitor resource.

Parameter
Name	Description
featureMonitorName	string A fully-qualified path representing FeatureMonitor resource.

Returns
Type	Description
string | number	{string} A string representing the location.

matchLocationFromFeatureOnlineStoreName(featureOnlineStoreName)

matchLocationFromFeatureOnlineStoreName(featureOnlineStoreName: string): string | number;

Parse the location from FeatureOnlineStore resource.

Parameter
Name	Description
featureOnlineStoreName	string A fully-qualified path representing FeatureOnlineStore resource.

Returns
Type	Description
string | number	{string} A string representing the location.

matchLocationFromFeaturestoreName(featurestoreName)

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.

matchLocationFromFeatureViewName(featureViewName)

matchLocationFromFeatureViewName(featureViewName: string): string | number;

Parse the location from FeatureView resource.

Parameter
Name	Description
featureViewName	string A fully-qualified path representing FeatureView resource.

Returns
Type	Description
string | number	{string} A string representing the location.

matchLocationFromFeatureViewSyncName(featureViewSyncName)

matchLocationFromFeatureViewSyncName(featureViewSyncName: string): string | number;

Parse the location from FeatureViewSync resource.

Parameter
Name	Description
featureViewSyncName	string A fully-qualified path representing FeatureViewSync resource.

Returns
Type	Description
string | number	{string} A string representing the location.

matchLocationFromHyperparameterTuningJobName(hyperparameterTuningJobName)

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)

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)

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)

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.

matchLocationFromMemoryName(memoryName)

matchLocationFromMemoryName(memoryName: string): string | number;

Parse the location from Memory resource.

Parameter
Name	Description
memoryName	string A fully-qualified path representing Memory resource.

Returns
Type	Description
string | number	{string} A string representing the location.

matchLocationFromMetadataSchemaName(metadataSchemaName)

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)

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)

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)

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)

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.

matchLocationFromModelMonitoringJobName(modelMonitoringJobName)

matchLocationFromModelMonitoringJobName(modelMonitoringJobName: string): string | number;

Parse the location from ModelMonitoringJob resource.

Parameter
Name	Description
modelMonitoringJobName	string A fully-qualified path representing ModelMonitoringJob resource.

Returns
Type	Description
string | number	{string} A string representing the location.

matchLocationFromModelMonitorName(modelMonitorName)

matchLocationFromModelMonitorName(modelMonitorName: string): string | number;

Parse the location from ModelMonitor resource.

Parameter
Name	Description
modelMonitorName	string A fully-qualified path representing ModelMonitor resource.

Returns
Type	Description
string | number	{string} A string representing the location.

matchLocationFromModelName(modelName)

matchLocationFromModelName(modelName: string): string | number;

Parse the location from Model resource.

Parameter
Name	Description
modelName	string