Service for reading and writing metadata entries. v1beta1
Package
@google-cloud/aiplatform
Constructors
constructor(opts?: ClientOptions, gaxInstance?: typeof gax | typeof gax.fallback);
Construct an instance of MetadataServiceClient.
| 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 MetadataServiceClient({fallback: true}, gax); ```
|
Properties
get apiEndpoint(): string;
The DNS address for this API service.
static get apiEndpoint(): string;
The DNS address for this API service - same as servicePath.
descriptors: Descriptors;
innerApiCalls: {
[name: string]: Function;
};
locationsClient: LocationsClient;
metadataServiceStub?: Promise<{
[name: string]: Function;
}>;
operationsClient: gax.OperationsClient;
pathTemplates: {
[name: string]: gax.PathTemplate;
};
static get port(): number;
The port for this API service.
static get scopes(): string[];
The scopes needed to make gRPC calls for every method defined in this service.
static get servicePath(): string;
The DNS address for this API service.
universeDomain
get universeDomain(): string;
warn: (code: string, message: string, warnType?: string) => void;
Methods
addContextArtifactsAndExecutions(request, options)
addContextArtifactsAndExecutions(request?: protos.google.cloud.aiplatform.v1beta1.IAddContextArtifactsAndExecutionsRequest, options?: CallOptions): Promise<[
protos.google.cloud.aiplatform.v1beta1.IAddContextArtifactsAndExecutionsResponse,
protos.google.cloud.aiplatform.v1beta1.IAddContextArtifactsAndExecutionsRequest | undefined,
{} | undefined
]>;
Adds a set of Artifacts and Executions to a Context. If any of the Artifacts or Executions have already been added to a Context, they are simply skipped.
/**
* 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 Context that the Artifacts and
* Executions belong to. Format:
* `projects/{project}/locations/{location}/metadataStores/{metadatastore}/contexts/{context}`
*/
// const context = 'abc123'
/**
* The resource names of the Artifacts to attribute to the Context.
* Format:
* `projects/{project}/locations/{location}/metadataStores/{metadatastore}/artifacts/{artifact}`
*/
// const artifacts = ['abc','def']
/**
* The resource names of the Executions to associate with the
* Context.
* Format:
* `projects/{project}/locations/{location}/metadataStores/{metadatastore}/executions/{execution}`
*/
// const executions = ['abc','def']
// Imports the Aiplatform library
const {MetadataServiceClient} = require('@google-cloud/aiplatform').v1beta1;
// Instantiates a client
const aiplatformClient = new MetadataServiceClient();
async function callAddContextArtifactsAndExecutions() {
// Construct request
const request = {
context,
};
// Run request
const response = await aiplatformClient.addContextArtifactsAndExecutions(request);
console.log(response);
}
callAddContextArtifactsAndExecutions();
addContextArtifactsAndExecutions(request, options, callback)
addContextArtifactsAndExecutions(request: protos.google.cloud.aiplatform.v1beta1.IAddContextArtifactsAndExecutionsRequest, options: CallOptions, callback: Callback<protos.google.cloud.aiplatform.v1beta1.IAddContextArtifactsAndExecutionsResponse, protos.google.cloud.aiplatform.v1beta1.IAddContextArtifactsAndExecutionsRequest | null | undefined, {} | null | undefined>): void;
| Returns |
| Type |
Description |
void |
|
addContextArtifactsAndExecutions(request, callback)
addContextArtifactsAndExecutions(request: protos.google.cloud.aiplatform.v1beta1.IAddContextArtifactsAndExecutionsRequest, callback: Callback<protos.google.cloud.aiplatform.v1beta1.IAddContextArtifactsAndExecutionsResponse, protos.google.cloud.aiplatform.v1beta1.IAddContextArtifactsAndExecutionsRequest | null | undefined, {} | null | undefined>): void;
| Returns |
| Type |
Description |
void |
|
addContextChildren(request, options)
addContextChildren(request?: protos.google.cloud.aiplatform.v1beta1.IAddContextChildrenRequest, options?: CallOptions): Promise<[
protos.google.cloud.aiplatform.v1beta1.IAddContextChildrenResponse,
protos.google.cloud.aiplatform.v1beta1.IAddContextChildrenRequest | undefined,
{} | undefined
]>;
Adds a set of Contexts as children to a parent Context. If any of the child Contexts have already been added to the parent Context, they are simply skipped. If this call would create a cycle or cause any Context to have more than 10 parents, the request will fail with an INVALID_ARGUMENT error.
/**
* 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 parent Context.
* Format:
* `projects/{project}/locations/{location}/metadataStores/{metadatastore}/contexts/{context}`
*/
// const context = 'abc123'
/**
* The resource names of the child Contexts.
*/
// const childContexts = ['abc','def']
// Imports the Aiplatform library
const {MetadataServiceClient} = require('@google-cloud/aiplatform').v1beta1;
// Instantiates a client
const aiplatformClient = new MetadataServiceClient();
async function callAddContextChildren() {
// Construct request
const request = {
context,
};
// Run request
const response = await aiplatformClient.addContextChildren(request);
console.log(response);
}
callAddContextChildren();
addContextChildren(request, options, callback)
addContextChildren(request: protos.google.cloud.aiplatform.v1beta1.IAddContextChildrenRequest, options: CallOptions, callback: Callback<protos.google.cloud.aiplatform.v1beta1.IAddContextChildrenResponse, protos.google.cloud.aiplatform.v1beta1.IAddContextChildrenRequest | null | undefined, {} | null | undefined>): void;
| Returns |
| Type |
Description |
void |
|
addContextChildren(request, callback)
addContextChildren(request: protos.google.cloud.aiplatform.v1beta1.IAddContextChildrenRequest, callback: Callback<protos.google.cloud.aiplatform.v1beta1.IAddContextChildrenResponse, protos.google.cloud.aiplatform.v1beta1.IAddContextChildrenRequest | null | undefined, {} | null | undefined>): void;
| Returns |
| Type |
Description |
void |
|
addExecutionEvents(request?: protos.google.cloud.aiplatform.v1beta1.IAddExecutionEventsRequest, options?: CallOptions): Promise<[
protos.google.cloud.aiplatform.v1beta1.IAddExecutionEventsResponse,
protos.google.cloud.aiplatform.v1beta1.IAddExecutionEventsRequest | undefined,
{} | undefined
]>;
Adds Events to the specified Execution. An Event indicates whether an Artifact was used as an input or output for an Execution. If an Event already exists between the Execution and the Artifact, the Event is skipped.
/**
* 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 Execution that the Events connect
* Artifacts with.
* Format:
* `projects/{project}/locations/{location}/metadataStores/{metadatastore}/executions/{execution}`
*/
// const execution = 'abc123'
/**
* The Events to create and add.
*/
// const events = [1,2,3,4]
// Imports the Aiplatform library
const {MetadataServiceClient} = require('@google-cloud/aiplatform').v1beta1;
// Instantiates a client
const aiplatformClient = new MetadataServiceClient();
async function callAddExecutionEvents() {
// Construct request
const request = {
execution,
};
// Run request
const response = await aiplatformClient.addExecutionEvents(request);
console.log(response);
}
callAddExecutionEvents();
addExecutionEvents(request: protos.google.cloud.aiplatform.v1beta1.IAddExecutionEventsRequest, options: CallOptions, callback: Callback<protos.google.cloud.aiplatform.v1beta1.IAddExecutionEventsResponse, protos.google.cloud.aiplatform.v1beta1.IAddExecutionEventsRequest | null | undefined, {} | null | undefined>): void;
| Returns |
| Type |
Description |
void |
|
addExecutionEvents(request: protos.google.cloud.aiplatform.v1beta1.IAddExecutionEventsRequest, callback: Callback<protos.google.cloud.aiplatform.v1beta1.IAddExecutionEventsResponse, protos.google.cloud.aiplatform.v1beta1.IAddExecutionEventsRequest | null | undefined, {} | null | undefined>): void;
| Returns |
| Type |
Description |
void |
|
annotationPath(project: string, location: string, dataset: string, dataItem: string, annotation: string): string;
Return a fully-qualified annotation resource name string.
| Parameters |
| Name |
Description |
project |
string
|
location |
string
|
dataset |
string
|
dataItem |
string
|
annotation |
string
|
| Returns |
| Type |
Description |
string |
{string} Resource name string.
|
annotationSpecPath(project: string, location: string, dataset: string, annotationSpec: string): string;
Return a fully-qualified annotationSpec resource name string.
| Parameters |
| Name |
Description |
project |
string
|
location |
string
|
dataset |
string
|
annotationSpec |
string
|
| Returns |
| Type |
Description |
string |
{string} Resource name string.
|
artifactPath(project: string, location: string, metadataStore: string, artifact: string): string;
Return a fully-qualified artifact resource name string.
| Parameters |
| Name |
Description |
project |
string
|
location |
string
|
metadataStore |
string
|
artifact |
string
|
| Returns |
| Type |
Description |
string |
{string} Resource name string.
|
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: 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.
const client = longrunning.operationsClient();
await client.cancelOperation({name: ''});
checkCreateMetadataStoreProgress(name: string): Promise<LROperation<protos.google.cloud.aiplatform.v1beta1.MetadataStore, protos.google.cloud.aiplatform.v1beta1.CreateMetadataStoreOperationMetadata>>;
Check the status of the long running operation returned by createMetadataStore().
| Parameter |
| Name |
Description |
name |
string
The operation name that will be passed.
|
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 where the MetadataStore should
* be created.
* Format: `projects/{project}/locations/{location}/`
*/
// const parent = 'abc123'
/**
* Required. The MetadataStore to create.
*/
// const metadataStore = {}
/**
* The {metadatastore} portion of the resource name with the format:
* `projects/{project}/locations/{location}/metadataStores/{metadatastore}`
* If not provided, the MetadataStore's ID will be a UUID generated by the
* service.
* Must be 4-128 characters in length. Valid characters are `/[a-z][0-9]-/`.
* Must be unique across all MetadataStores in the parent Location.
* (Otherwise the request will fail with ALREADY_EXISTS, or PERMISSION_DENIED
* if the caller can't view the preexisting MetadataStore.)
*/
// const metadataStoreId = 'abc123'
// Imports the Aiplatform library
const {MetadataServiceClient} = require('@google-cloud/aiplatform').v1beta1;
// Instantiates a client
const aiplatformClient = new MetadataServiceClient();
async function callCreateMetadataStore() {
// Construct request
const request = {
parent,
metadataStore,
};
// Run request
const [operation] = await aiplatformClient.createMetadataStore(request);
const [response] = await operation.promise();
console.log(response);
}
callCreateMetadataStore();
checkDeleteArtifactProgress(name: string): Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.aiplatform.v1beta1.DeleteOperationMetadata>>;
Check the status of the long running operation returned by deleteArtifact().
| Parameter |
| Name |
Description |
name |
string
The operation name that will be passed.
|
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 Artifact to delete.
* Format:
* `projects/{project}/locations/{location}/metadataStores/{metadatastore}/artifacts/{artifact}`
*/
// const name = 'abc123'
/**
* Optional. The etag of the Artifact to delete.
* If this is provided, it must match the server's etag. Otherwise, the
* request will fail with a FAILED_PRECONDITION.
*/
// const etag = 'abc123'
// Imports the Aiplatform library
const {MetadataServiceClient} = require('@google-cloud/aiplatform').v1beta1;
// Instantiates a client
const aiplatformClient = new MetadataServiceClient();
async function callDeleteArtifact() {
// Construct request
const request = {
name,
};
// Run request
const [operation] = await aiplatformClient.deleteArtifact(request);
const [response] = await operation.promise();
console.log(response);
}
callDeleteArtifact();
checkDeleteContextProgress(name)
checkDeleteContextProgress(name: string): Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.aiplatform.v1beta1.DeleteOperationMetadata>>;
Check the status of the long running operation returned by deleteContext().
| Parameter |
| Name |
Description |
name |
string
The operation name that will be passed.
|
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 Context to delete.
* Format:
* `projects/{project}/locations/{location}/metadataStores/{metadatastore}/contexts/{context}`
*/
// const name = 'abc123'
/**
* The force deletion semantics is still undefined.
* Users should not use this field.
*/
// const force = true
/**
* Optional. The etag of the Context to delete.
* If this is provided, it must match the server's etag. Otherwise, the
* request will fail with a FAILED_PRECONDITION.
*/
// const etag = 'abc123'
// Imports the Aiplatform library
const {MetadataServiceClient} = require('@google-cloud/aiplatform').v1beta1;
// Instantiates a client
const aiplatformClient = new MetadataServiceClient();
async function callDeleteContext() {
// Construct request
const request = {
name,
};
// Run request
const [operation] = await aiplatformClient.deleteContext(request);
const [response] = await operation.promise();
console.log(response);
}
callDeleteContext();
checkDeleteExecutionProgress(name: string): Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.aiplatform.v1beta1.DeleteOperationMetadata>>;
Check the status of the long running operation returned by deleteExecution().
| Parameter |
| Name |
Description |
name |
string
The operation name that will be passed.
|
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 Execution to delete.
* Format:
* `projects/{project}/locations/{location}/metadataStores/{metadatastore}/executions/{execution}`
*/
// const name = 'abc123'
/**
* Optional. The etag of the Execution to delete.
* If this is provided, it must match the server's etag. Otherwise, the
* request will fail with a FAILED_PRECONDITION.
*/
// const etag = 'abc123'
// Imports the Aiplatform library
const {MetadataServiceClient} = require('@google-cloud/aiplatform').v1beta1;
// Instantiates a client
const aiplatformClient = new MetadataServiceClient();
async function callDeleteExecution() {
// Construct request
const request = {
name,
};
// Run request
const [operation] = await aiplatformClient.deleteExecution(request);
const [response] = await operation.promise();
console.log(response);
}
callDeleteExecution();
checkDeleteMetadataStoreProgress(name: string): Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.aiplatform.v1beta1.DeleteMetadataStoreOperationMetadata>>;
Check the status of the long running operation returned by deleteMetadataStore().
| Parameter |
| Name |
Description |
name |
string
The operation name that will be passed.
|
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 MetadataStore to delete.
* Format:
* `projects/{project}/locations/{location}/metadataStores/{metadatastore}`
*/
// const name = 'abc123'
// Imports the Aiplatform library
const {MetadataServiceClient} = require('@google-cloud/aiplatform').v1beta1;
// Instantiates a client
const aiplatformClient = new MetadataServiceClient();
async function callDeleteMetadataStore() {
// Construct request
const request = {
name,
};
// Run request
const [operation] = await aiplatformClient.deleteMetadataStore(request);
const [response] = await operation.promise();
console.log(response);
}
callDeleteMetadataStore();
checkPurgeArtifactsProgress(name: string): Promise<LROperation<protos.google.cloud.aiplatform.v1beta1.PurgeArtifactsResponse, protos.google.cloud.aiplatform.v1beta1.PurgeArtifactsMetadata>>;
Check the status of the long running operation returned by purgeArtifacts().
| Parameter |
| Name |
Description |
name |
string
The operation name that will be passed.
|
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 metadata store to purge Artifacts from.
* Format:
* `projects/{project}/locations/{location}/metadataStores/{metadatastore}`
*/
// const parent = 'abc123'
/**
* Required. A required filter matching the Artifacts to be purged.
* E.g., `update_time <= 2020-11-19t11:30:00-04:00`.="" */="" const="" filter='abc123' *="" *="" optional.="" flag="" to="" indicate="" to="" actually="" perform="" the="" purge.="" *="" if="" `force`="" is="" set="" to="" false,="" the="" method="" will="" return="" a="" sample="" of="" *="" artifact="" names="" that="" would="" be="" deleted.="" */="" const="" force="true" imports="" the="" aiplatform="" library="" const="" {metadataserviceclient}="require('@google-cloud/aiplatform').v1beta1;" instantiates="" a="" client="" const="" aiplatformclient="new" metadataserviceclient();="" async="" function="" callpurgeartifacts()="" {="" construct="" request="" const="" request="{" parent,="" filter,="" };="" run="" request="" const="" [operation]="await" aiplatformclient.purgeartifacts(request);="" const="" [response]="await" operation.promise();="" console.log(response);="" }="" callpurgeartifacts();="">
checkPurgeContextsProgress(name)
checkPurgeContextsProgress(name: string): Promise<LROperation<protos.google.cloud.aiplatform.v1beta1.PurgeContextsResponse, protos.google.cloud.aiplatform.v1beta1.PurgeContextsMetadata>>;
Check the status of the long running operation returned by purgeContexts().
| Parameter |
| Name |
Description |
name |
string
The operation name that will be passed.
|
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 metadata store to purge Contexts from.
* Format:
* `projects/{project}/locations/{location}/metadataStores/{metadatastore}`
*/
// const parent = 'abc123'
/**
* Required. A required filter matching the Contexts to be purged.
* E.g., `update_time <= 2020-11-19t11:30:00-04:00`.="" */="" const="" filter='abc123' *="" *="" optional.="" flag="" to="" indicate="" to="" actually="" perform="" the="" purge.="" *="" if="" `force`="" is="" set="" to="" false,="" the="" method="" will="" return="" a="" sample="" of="" *="" context="" names="" that="" would="" be="" deleted.="" */="" const="" force="true" imports="" the="" aiplatform="" library="" const="" {metadataserviceclient}="require('@google-cloud/aiplatform').v1beta1;" instantiates="" a="" client="" const="" aiplatformclient="new" metadataserviceclient();="" async="" function="" callpurgecontexts()="" {="" construct="" request="" const="" request="{" parent,="" filter,="" };="" run="" request="" const="" [operation]="await" aiplatformclient.purgecontexts(request);="" const="" [response]="await" operation.promise();="" console.log(response);="" }="" callpurgecontexts();="">
checkPurgeExecutionsProgress(name: string): Promise<LROperation<protos.google.cloud.aiplatform.v1beta1.PurgeExecutionsResponse, protos.google.cloud.aiplatform.v1beta1.PurgeExecutionsMetadata>>;
Check the status of the long running operation returned by purgeExecutions().
| Parameter |
| Name |
Description |
name |
string
The operation name that will be passed.
|
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 metadata store to purge Executions from.
* Format:
* `projects/{project}/locations/{location}/metadataStores/{metadatastore}`
*/
// const parent = 'abc123'
/**
* Required. A required filter matching the Executions to be purged.
* E.g., `update_time <= 2020-11-19t11:30:00-04:00`.="" */="" const="" filter='abc123' *="" *="" optional.="" flag="" to="" indicate="" to="" actually="" perform="" the="" purge.="" *="" if="" `force`="" is="" set="" to="" false,="" the="" method="" will="" return="" a="" sample="" of="" *="" execution="" names="" that="" would="" be="" deleted.="" */="" const="" force="true" imports="" the="" aiplatform="" library="" const="" {metadataserviceclient}="require('@google-cloud/aiplatform').v1beta1;" instantiates="" a="" client="" const="" aiplatformclient="new" metadataserviceclient();="" async="" function="" callpurgeexecutions()="" {="" construct="" request="" const="" request="{" parent,="" filter,="" };="" run="" request="" const="" [operation]="await" aiplatformclient.purgeexecutions(request);="" const="" [response]="await" operation.promise();="" console.log(response);="" }="" callpurgeexecutions();="">
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.
|
createArtifact(request?: protos.google.cloud.aiplatform.v1beta1.ICreateArtifactRequest, options?: CallOptions): Promise<[
protos.google.cloud.aiplatform.v1beta1.IArtifact,
protos.google.cloud.aiplatform.v1beta1.ICreateArtifactRequest | undefined,
{} | undefined
]>;
Creates an Artifact associated with a MetadataStore.
/**
* 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 MetadataStore where the Artifact should
* be created.
* Format:
* `projects/{project}/locations/{location}/metadataStores/{metadatastore}`
*/
// const parent = 'abc123'
/**
* Required. The Artifact to create.
*/
// const artifact = {}
/**
* The {artifact} portion of the resource name with the format:
* `projects/{project}/locations/{location}/metadataStores/{metadatastore}/artifacts/{artifact}`
* If not provided, the Artifact's ID will be a UUID generated by the service.
* Must be 4-128 characters in length. Valid characters are `/[a-z][0-9]-/`.
* Must be unique across all Artifacts in the parent MetadataStore. (Otherwise
* the request will fail with ALREADY_EXISTS, or PERMISSION_DENIED if the
* caller can't view the preexisting Artifact.)
*/
// const artifactId = 'abc123'
// Imports the Aiplatform library
const {MetadataServiceClient} = require('@google-cloud/aiplatform').v1beta1;
// Instantiates a client
const aiplatformClient = new MetadataServiceClient();
async function callCreateArtifact() {
// Construct request
const request = {
parent,
artifact,
};
// Run request
const response = await aiplatformClient.createArtifact(request);
console.log(response);
}
callCreateArtifact();
createArtifact(request: protos.google.cloud.aiplatform.v1beta1.ICreateArtifactRequest, options: CallOptions, callback: Callback<protos.google.cloud.aiplatform.v1beta1.IArtifact, protos.google.cloud.aiplatform.v1beta1.ICreateArtifactRequest | null | undefined, {} | null | undefined>): void;
| Returns |
| Type |
Description |
void |
|
createArtifact(request: protos.google.cloud.aiplatform.v1beta1.ICreateArtifactRequest, callback: Callback<protos.google.cloud.aiplatform.v1beta1.IArtifact, protos.google.cloud.aiplatform.v1beta1.ICreateArtifactRequest | null | undefined, {} | null | undefined>): void;
| Returns |
| Type |
Description |
void |
|
createContext(request, options)
createContext(request?: protos.google.cloud.aiplatform.v1beta1.ICreateContextRequest, options?: CallOptions): Promise<[
protos.google.cloud.aiplatform.v1beta1.IContext,
protos.google.cloud.aiplatform.v1beta1.ICreateContextRequest | undefined,
{} | undefined
]>;
Creates a Context associated with a MetadataStore.
| Parameters |
| Name |
Description |
request |
ICreateContextRequest
The request object that will be sent.
|
options |
CallOptions
Call options. See CallOptions for more details.
|
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 MetadataStore where the Context should
* be created. Format:
* `projects/{project}/locations/{location}/metadataStores/{metadatastore}`
*/
// const parent = 'abc123'
/**
* Required. The Context to create.
*/
// const context = {}
/**
* The {context} portion of the resource name with the format:
* `projects/{project}/locations/{location}/metadataStores/{metadatastore}/contexts/{context}`.
* If not provided, the Context's ID will be a UUID generated by the service.
* Must be 4-128 characters in length. Valid characters are `/[a-z][0-9]-/`.
* Must be unique across all Contexts in the parent MetadataStore. (Otherwise
* the request will fail with ALREADY_EXISTS, or PERMISSION_DENIED if the
* caller can't view the preexisting Context.)
*/
// const contextId = 'abc123'
// Imports the Aiplatform library
const {MetadataServiceClient} = require('@google-cloud/aiplatform').v1beta1;
// Instantiates a client
const aiplatformClient = new MetadataServiceClient();
async function callCreateContext() {
// Construct request
const request = {
parent,
context,
};
// Run request
const response = await aiplatformClient.createContext(request);
console.log(response);
}
callCreateContext();
createContext(request, options, callback)
createContext(request: protos.google.cloud.aiplatform.v1beta1.ICreateContextRequest, options: CallOptions, callback: Callback<protos.google.cloud.aiplatform.v1beta1.IContext, protos.google.cloud.aiplatform.v1beta1.ICreateContextRequest | null | undefined, {} | null | undefined>): void;
| Returns |
| Type |
Description |
void |
|
createContext(request, callback)
createContext(request: protos.google.cloud.aiplatform.v1beta1.ICreateContextRequest, callback: Callback<protos.google.cloud.aiplatform.v1beta1.IContext, protos.google.cloud.aiplatform.v1beta1.ICreateContextRequest | null | undefined, {} | null | undefined>): void;
| Returns |
| Type |
Description |
void |
|
createExecution(request?: protos.google.cloud.aiplatform.v1beta1.ICreateExecutionRequest, options?: CallOptions): Promise<[
protos.google.cloud.aiplatform.v1beta1.IExecution,
protos.google.cloud.aiplatform.v1beta1.ICreateExecutionRequest | undefined,
{} | undefined
]>;
Creates an Execution associated with a MetadataStore.
/**
* 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 MetadataStore where the Execution should
* be created.
* Format:
* `projects/{project}/locations/{location}/metadataStores/{metadatastore}`
*/
// const parent = 'abc123'
/**
* Required. The Execution to create.
*/
// const execution = {}
/**
* The {execution} portion of the resource name with the format:
* `projects/{project}/locations/{location}/metadataStores/{metadatastore}/executions/{execution}`
* If not provided, the Execution's ID will be a UUID generated by the
* service.
* Must be 4-128 characters in length. Valid characters are `/[a-z][0-9]-/`.
* Must be unique across all Executions in the parent MetadataStore.
* (Otherwise the request will fail with ALREADY_EXISTS, or PERMISSION_DENIED
* if the caller can't view the preexisting Execution.)
*/
// const executionId = 'abc123'
// Imports the Aiplatform library
const {MetadataServiceClient} = require('@google-cloud/aiplatform').v1beta1;
// Instantiates a client
const aiplatformClient = new MetadataServiceClient();
async function callCreateExecution() {
// Construct request
const request = {
parent,
execution,
};
// Run request
const response = await aiplatformClient.createExecution(request);
console.log(response);
}
callCreateExecution();
createExecution(request: protos.google.cloud.aiplatform.v1beta1.ICreateExecutionRequest, options: CallOptions, callback: Callback<protos.google.cloud.aiplatform.v1beta1.IExecution, protos.google.cloud.aiplatform.v1beta1.ICreateExecutionRequest | null | undefined, {} | null | undefined>): void;
| Returns |
| Type |
Description |
void |
|
createExecution(request: protos.google.cloud.aiplatform.v1beta1.ICreateExecutionRequest, callback: Callback<protos.google.cloud.aiplatform.v1beta1.IExecution, protos.google.cloud.aiplatform.v1beta1.ICreateExecutionRequest | null | undefined, {} | null | undefined>): void;
| Returns |
| Type |
Description |
void |
|
createMetadataSchema(request?: protos.google.cloud.aiplatform.v1beta1.ICreateMetadataSchemaRequest, options?: CallOptions): Promise<[
protos.google.cloud.aiplatform.v1beta1.IMetadataSchema,
protos.google.cloud.aiplatform.v1beta1.ICreateMetadataSchemaRequest | undefined,
{} | undefined
]>;
Creates a MetadataSchema.
/**
* 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 MetadataStore where the MetadataSchema
* should be created. Format:
* `projects/{project}/locations/{location}/metadataStores/{metadatastore}`
*/
// const parent = 'abc123'
/**
* Required. The MetadataSchema to create.
*/
// const metadataSchema = {}
/**
* The {metadata_schema} portion of the resource name with the format:
* `projects/{project}/locations/{location}/metadataStores/{metadatastore}/metadataSchemas/{metadataschema}`
* If not provided, the MetadataStore's ID will be a UUID generated by the
* service.
* Must be 4-128 characters in length. Valid characters are `/[a-z][0-9]-/`.
* Must be unique across all MetadataSchemas in the parent Location.
* (Otherwise the request will fail with ALREADY_EXISTS, or PERMISSION_DENIED
* if the caller can't view the preexisting MetadataSchema.)
*/
// const metadataSchemaId = 'abc123'
// Imports the Aiplatform library
const {MetadataServiceClient} = require('@google-cloud/aiplatform').v1beta1;
// Instantiates a client
const aiplatformClient = new MetadataServiceClient();
async function callCreateMetadataSchema() {
// Construct request
const request = {
parent,
metadataSchema,
};
// Run request
const response = await aiplatformClient.createMetadataSchema(request);
console.log(response);
}
callCreateMetadataSchema();
createMetadataSchema(request: protos.google.cloud.aiplatform.v1beta1.ICreateMetadataSchemaRequest, options: CallOptions, callback: Callback<protos.google.cloud.aiplatform.v1beta1.IMetadataSchema, protos.google.cloud.aiplatform.v1beta1.ICreateMetadataSchemaRequest | null | undefined, {} | null | undefined>): void;
| Returns |
| Type |
Description |
void |
|
createMetadataSchema(request: protos.google.cloud.aiplatform.v1beta1.ICreateMetadataSchemaRequest, callback: Callback<protos.google.cloud.aiplatform.v1beta1.IMetadataSchema, protos.google.cloud.aiplatform.v1beta1.ICreateMetadataSchemaRequest | null | undefined, {} | null | undefined>): void;
| Returns |
| Type |
Description |
void |
|
createMetadataStore(request?: protos.google.cloud.aiplatform.v1beta1.ICreateMetadataStoreRequest, options?: CallOptions): Promise<[
LROperation<protos.google.cloud.aiplatform.v1beta1.IMetadataStore, protos.google.cloud.aiplatform.v1beta1.ICreateMetadataStoreOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]>;
Initializes a MetadataStore, including allocation of resources.
/**
* 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 where the MetadataStore should
* be created.
* Format: `projects/{project}/locations/{location}/`
*/
// const parent = 'abc123'
/**
* Required. The MetadataStore to create.
*/
// const metadataStore = {}
/**
* The {metadatastore} portion of the resource name with the format:
* `projects/{project}/locations/{location}/metadataStores/{metadatastore}`
* If not provided, the MetadataStore's ID will be a UUID generated by the
* service.
* Must be 4-128 characters in length. Valid characters are `/[a-z][0-9]-/`.
* Must be unique across all MetadataStores in the parent Location.
* (Otherwise the request will fail with ALREADY_EXISTS, or PERMISSION_DENIED
* if the caller can't view the preexisting MetadataStore.)
*/
// const metadataStoreId = 'abc123'
// Imports the Aiplatform library
const {MetadataServiceClient} = require('@google-cloud/aiplatform').v1beta1;
// Instantiates a client
const aiplatformClient = new MetadataServiceClient();
async function callCreateMetadataStore() {
// Construct request
const request = {
parent,
metadataStore,
};
// Run request
const [operation] = await aiplatformClient.createMetadataStore(request);
const [response] = await operation.promise();
console.log(response);
}
callCreateMetadataStore();
createMetadataStore(request: protos.google.cloud.aiplatform.v1beta1.ICreateMetadataStoreRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.aiplatform.v1beta1.IMetadataStore, protos.google.cloud.aiplatform.v1beta1.ICreateMetadataStoreOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
| Returns |
| Type |
Description |
void |
|
createMetadataStore(request: protos.google.cloud.aiplatform.v1beta1.ICreateMetadataStoreRequest, callback: Callback<LROperation<protos.google.cloud.aiplatform.v1beta1.IMetadataStore, protos.google.cloud.aiplatform.v1beta1.ICreateMetadataStoreOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
| Returns |
| Type |
Description |
void |
|
customJobPath(project: string, location: string, customJob: string): string;
Return a fully-qualified customJob resource name string.
| Parameters |
| Name |
Description |
project |
string
|
location |
string
|
customJob |
string
|
| Returns |
| Type |
Description |
string |
{string} Resource name string.
|
dataItemPath(project: string, location: string, dataset: string, dataItem: string): string;
Return a fully-qualified dataItem resource name string.
| Parameters |
| Name |
Description |
project |
string
|
location |
string
|
dataset |
string
|
dataItem |
string
|
| Returns |
| Type |
Description |
string |
{string} Resource name string.
|
dataLabelingJobPath(project: string, location: string, dataLabelingJob: string): string;
Return a fully-qualified dataLabelingJob resource name string.
| Parameters |
| Name |
Description |
project |
string
|
location |
string
|
dataLabelingJob |
string
|
| Returns |
| Type |
Description |
string |
{string} Resource name string.
|
datasetPath(project: string, location: string, dataset: string): string;
Return a fully-qualified dataset resource name string.
| Parameters |
| Name |
Description |
project |
string
|
location |
string
|
dataset |
string
|
| Returns |
| Type |
Description |
string |
{string} Resource name string.
|
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.
|
deleteArtifact(request?: protos.google.cloud.aiplatform.v1beta1.IDeleteArtifactRequest, options?: CallOptions): Promise<[
LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.aiplatform.v1beta1.IDeleteOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]>;
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 Artifact to delete.
* Format:
* `projects/{project}/locations/{location}/metadataStores/{metadatastore}/artifacts/{artifact}`
*/
// const name = 'abc123'
/**
* Optional. The etag of the Artifact to delete.
* If this is provided, it must match the server's etag. Otherwise, the
* request will fail with a FAILED_PRECONDITION.
*/
// const etag = 'abc123'
// Imports the Aiplatform library
const {MetadataServiceClient} = require('@google-cloud/aiplatform').v1beta1;
// Instantiates a client
const aiplatformClient = new MetadataServiceClient();
async function callDeleteArtifact() {
// Construct request
const request = {
name,
};
// Run request
const [operation] = await aiplatformClient.deleteArtifact(request);
const [response] = await operation.promise();
console.log(response);
}
callDeleteArtifact();
deleteArtifact(request: protos.google.cloud.aiplatform.v1beta1.IDeleteArtifactRequest, options: CallOptions, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.aiplatform.v1beta1.IDeleteOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
| Returns |
| Type |
Description |
void |
|
deleteArtifact(request: protos.google.cloud.aiplatform.v1beta1.IDeleteArtifactRequest, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.aiplatform.v1beta1.IDeleteOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
| Returns |
| Type |
Description |
void |
|
deleteContext(request, options)
deleteContext(request?: protos.google.cloud.aiplatform.v1beta1.IDeleteContextRequest, options?: CallOptions): Promise<[
LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.aiplatform.v1beta1.IDeleteOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]>;
Deletes a stored Context.
| Parameters |
| Name |
Description |
request |
IDeleteContextRequest
The request object that will be sent.
|
options |
CallOptions
Call options. See CallOptions for more details.
|
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 Context to delete.
* Format:
* `projects/{project}/locations/{location}/metadataStores/{metadatastore}/contexts/{context}`
*/
// const name = 'abc123'
/**
* The force deletion semantics is still undefined.
* Users should not use this field.
*/
// const force = true
/**
* Optional. The etag of the Context to delete.
* If this is provided, it must match the server's etag. Otherwise, the
* request will fail with a FAILED_PRECONDITION.
*/
// const etag = 'abc123'
// Imports the Aiplatform library
const {MetadataServiceClient} = require('@google-cloud/aiplatform').v1beta1;
// Instantiates a client
const aiplatformClient = new MetadataServiceClient();
async function callDeleteContext() {
// Construct request
const request = {
name,
};
// Run request
const [operation] = await aiplatformClient.deleteContext(request);
const [response] = await operation.promise();
console.log(response);
}
callDeleteContext();
deleteContext(request, options, callback)
deleteContext(request: protos.google.cloud.aiplatform.v1beta1.IDeleteContextRequest, options: CallOptions, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.aiplatform.v1beta1.IDeleteOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
| Returns |
| Type |
Description |
void |
|
deleteContext(request, callback)
deleteContext(request: protos.google.cloud.aiplatform.v1beta1.IDeleteContextRequest, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.aiplatform.v1beta1.IDeleteOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
| Returns |
| Type |
Description |
void |
|
deleteExecution(request?: protos.google.cloud.aiplatform.v1beta1.IDeleteExecutionRequest, options?: CallOptions): Promise<[
LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.aiplatform.v1beta1.IDeleteOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]>;
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 Execution to delete.
* Format:
* `projects/{project}/locations/{location}/metadataStores/{metadatastore}/executions/{execution}`
*/
// const name = 'abc123'
/**
* Optional. The etag of the Execution to delete.
* If this is provided, it must match the server's etag. Otherwise, the
* request will fail with a FAILED_PRECONDITION.
*/
// const etag = 'abc123'
// Imports the Aiplatform library
const {MetadataServiceClient} = require('@google-cloud/aiplatform').v1beta1;
// Instantiates a client
const aiplatformClient = new MetadataServiceClient();
async function callDeleteExecution() {
// Construct request
const request = {
name,
};
// Run request
const [operation] = await aiplatformClient.deleteExecution(request);
const [response] = await operation.promise();
console.log(response);
}
callDeleteExecution();
deleteExecution(request: protos.google.cloud.aiplatform.v1beta1.IDeleteExecutionRequest, options: CallOptions, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.aiplatform.v1beta1.IDeleteOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
| Returns |
| Type |
Description |
void |
|
deleteExecution(request: protos.google.cloud.aiplatform.v1beta1.IDeleteExecutionRequest, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.aiplatform.v1beta1.IDeleteOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
| Returns |
| Type |
Description |
void |
|
deleteMetadataStore(request?: protos.google.cloud.aiplatform.v1beta1.IDeleteMetadataStoreRequest, options?: CallOptions): Promise<[
LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.aiplatform.v1beta1.IDeleteMetadataStoreOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]>;
Deletes a single MetadataStore and all its child resources (Artifacts, Executions, and Contexts).
/**
* 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 MetadataStore to delete.
* Format:
* `projects/{project}/locations/{location}/metadataStores/{metadatastore}`
*/
// const name = 'abc123'
// Imports the Aiplatform library
const {MetadataServiceClient} = require('@google-cloud/aiplatform').v1beta1;
// Instantiates a client
const aiplatformClient = new MetadataServiceClient();
async function callDeleteMetadataStore() {
// Construct request
const request = {
name,
};
// Run request
const [operation] = await aiplatformClient.deleteMetadataStore(request);
const [response] = await operation.promise();
console.log(response);
}
callDeleteMetadataStore();
deleteMetadataStore(request: protos.google.cloud.aiplatform.v1beta1.IDeleteMetadataStoreRequest, options: CallOptions, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.aiplatform.v1beta1.IDeleteMetadataStoreOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
| Returns |
| Type |
Description |
void |
|
deleteMetadataStore(request: protos.google.cloud.aiplatform.v1beta1.IDeleteMetadataStoreRequest, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.aiplatform.v1beta1.IDeleteMetadataStoreOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
| Returns |
| Type |
Description |
void |
|
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.
const client = longrunning.operationsClient();
await client.deleteOperation({name: ''});
deploymentResourcePoolPath(project: string, location: string, deploymentResourcePool: string): string;
Return a fully-qualified deploymentResourcePool resource name string.
| Parameters |
| Name |
Description |
project |
string
|
location |
string
|
deploymentResourcePool |
string
|
| Returns |
| Type |
Description |
string |
{string} Resource name string.
|
entityTypePath(project: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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.
|
getArtifact(request?: protos.google.cloud.aiplatform.v1beta1.IGetArtifactRequest, options?: CallOptions): Promise<[
protos.google.cloud.aiplatform.v1beta1.IArtifact,
protos.google.cloud.aiplatform.v1beta1.IGetArtifactRequest | undefined,
{} | undefined
]>;
Retrieves a specific Artifact.
| Parameters |
| Name |
Description |
request |
IGetArtifactRequest
The request object that will be sent.
|
options |
CallOptions
Call options. See CallOptions for more details.
|
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 Artifact to retrieve.
* Format:
* `projects/{project}/locations/{location}/metadataStores/{metadatastore}/artifacts/{artifact}`
*/
// const name = 'abc123'
// Imports the Aiplatform library
const {MetadataServiceClient} = require('@google-cloud/aiplatform').v1beta1;
// Instantiates a client
const aiplatformClient = new MetadataServiceClient();
async function callGetArtifact() {
// Construct request
const request = {
name,
};
// Run request
const response = await aiplatformClient.getArtifact(request);
console.log(response);
}
callGetArtifact();
getArtifact(request: protos.google.cloud.aiplatform.v1beta1.IGetArtifactRequest, options: CallOptions, callback: Callback<protos.google.cloud.aiplatform.v1beta1.IArtifact, protos.google.cloud.aiplatform.v1beta1.IGetArtifactRequest | null | undefined, {} | null | undefined>): void;
| Returns |
| Type |
Description |
void |
|
getArtifact(request: protos.google.cloud.aiplatform.v1beta1.IGetArtifactRequest, callback: Callback<protos.google.cloud.aiplatform.v1beta1.IArtifact, protos.google.cloud.aiplatform.v1beta1.IGetArtifactRequest | null | undefined, {} | null | undefined>): void;
| Returns |
| Type |
Description |
void |
|
getContext(request, options)
getContext(request?: protos.google.cloud.aiplatform.v1beta1.IGetContextRequest, options?: CallOptions): Promise<[
protos.google.cloud.aiplatform.v1beta1.IContext,
protos.google.cloud.aiplatform.v1beta1.IGetContextRequest | undefined,
{} | undefined
]>;
Retrieves a specific Context.
| Parameters |
| Name |
Description |
request |
IGetContextRequest
The request object that will be sent.
|
options |
CallOptions
Call options. See CallOptions for more details.
|
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 Context to retrieve.
* Format:
* `projects/{project}/locations/{location}/metadataStores/{metadatastore}/contexts/{context}`
*/
// const name = 'abc123'
// Imports the Aiplatform library
const {MetadataServiceClient} = require('@google-cloud/aiplatform').v1beta1;
// Instantiates a client
const aiplatformClient = new MetadataServiceClient();
async function callGetContext() {
// Construct request
const request = {
name,
};
// Run request
const response = await aiplatformClient.getContext(request);
console.log(response);
}
callGetContext();
getContext(request, options, callback)
getContext(request: protos.google.cloud.aiplatform.v1beta1.IGetContextRequest, options: CallOptions, callback: Callback<protos.google.cloud.aiplatform.v1beta1.IContext, protos.google.cloud.aiplatform.v1beta1.IGetContextRequest | null | undefined, {} | null | undefined>): void;
| Returns |
| Type |
Description |
void |
|
getContext(request, callback)
getContext(request: protos.google.cloud.aiplatform.v1beta1.IGetContextRequest, callback: Callback<protos.google.cloud.aiplatform.v1beta1.IContext, protos.google.cloud.aiplatform.v1beta1.IGetContextRequest | null | undefined, {} | null | undefined>): void;
| Returns |
| Type |
Description |
void |
|
getExecution(request?: protos.google.cloud.aiplatform.v1beta1.IGetExecutionRequest, options?: CallOptions): Promise<[
protos.google.cloud.aiplatform.v1beta1.IExecution,
protos.google.cloud.aiplatform.v1beta1.IGetExecutionRequest | undefined,
{} | undefined
]>;
Retrieves a specific Execution.
| Parameters |
| Name |
Description |
request |
IGetExecutionRequest
The request object that will be sent.
|
options |
CallOptions
Call options. See CallOptions for more details.
|
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 Execution to retrieve.
* Format:
* `projects/{project}/locations/{location}/metadataStores/{metadatastore}/executions/{execution}`
*/
// const name = 'abc123'
// Imports the Aiplatform library
const {MetadataServiceClient} = require('@google-cloud/aiplatform').v1beta1;
// Instantiates a client
const aiplatformClient = new MetadataServiceClient();
async function callGetExecution() {
// Construct request
const request = {
name,
};
// Run request
const response = await aiplatformClient.getExecution(request);
console.log(response);
}
callGetExecution();
getExecution(request: protos.google.cloud.aiplatform.v1beta1.IGetExecutionRequest, options: CallOptions, callback: Callback<protos.google.cloud.aiplatform.v1beta1.IExecution, protos.google.cloud.aiplatform.v1beta1.IGetExecutionRequest | null | undefined, {} | null | undefined>): void;
| Returns |
| Type |
Description |
void |
|
getExecution(request: protos.google.cloud.aiplatform.v1beta1.IGetExecutionRequest, callback: Callback<protos.google.cloud.aiplatform.v1beta1.IExecution, protos.google.cloud.aiplatform.v1beta1.IGetExecutionRequest | null | undefined, {} | null | undefined>): void;
| Returns |
| Type |
Description |
void |
|
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: 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);
getMetadataSchema(request?: protos.google.cloud.aiplatform.v1beta1.IGetMetadataSchemaRequest, options?: CallOptions): Promise<[
protos.google.cloud.aiplatform.v1beta1.IMetadataSchema,
protos.google.cloud.aiplatform.v1beta1.IGetMetadataSchemaRequest | undefined,
{} | undefined
]>;
Retrieves a specific MetadataSchema.
/**
* 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 MetadataSchema to retrieve.
* Format:
* `projects/{project}/locations/{location}/metadataStores/{metadatastore}/metadataSchemas/{metadataschema}`
*/
// const name = 'abc123'
// Imports the Aiplatform library
const {MetadataServiceClient} = require('@google-cloud/aiplatform').v1beta1;
// Instantiates a client
const aiplatformClient = new MetadataServiceClient();
async function callGetMetadataSchema() {
// Construct request
const request = {
name,
};
// Run request
const response = await aiplatformClient.getMetadataSchema(request);
console.log(response);
}
callGetMetadataSchema();
getMetadataSchema(request: protos.google.cloud.aiplatform.v1beta1.IGetMetadataSchemaRequest, options: CallOptions, callback: Callback<protos.google.cloud.aiplatform.v1beta1.IMetadataSchema, protos.google.cloud.aiplatform.v1beta1.IGetMetadataSchemaRequest | null | undefined, {} | null | undefined>): void;
| Returns |
| Type |
Description |
void |
|
getMetadataSchema(request: protos.google.cloud.aiplatform.v1beta1.IGetMetadataSchemaRequest, callback: Callback<protos.google.cloud.aiplatform.v1beta1.IMetadataSchema, protos.google.cloud.aiplatform.v1beta1.IGetMetadataSchemaRequest | null | undefined, {} | null | undefined>): void;
| Returns |
| Type |
Description |
void |
|
getMetadataStore(request?: protos.google.cloud.aiplatform.v1beta1.IGetMetadataStoreRequest, options?: CallOptions): Promise<[
protos.google.cloud.aiplatform.v1beta1.IMetadataStore,
protos.google.cloud.aiplatform.v1beta1.IGetMetadataStoreRequest | undefined,
{} | undefined
]>;
Retrieves a specific MetadataStore.
/**
* 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 MetadataStore to retrieve.
* Format:
* `projects/{project}/locations/{location}/metadataStores/{metadatastore}`
*/
// const name = 'abc123'
// Imports the Aiplatform library
const {MetadataServiceClient} = require('@google-cloud/aiplatform').v1beta1;
// Instantiates a client
const aiplatformClient = new MetadataServiceClient();
async function callGetMetadataStore() {
// Construct request
const request = {
name,
};
// Run request
const response = await aiplatformClient.getMetadataStore(request);
console.log(response);
}
callGetMetadataStore();
