Service for managing Machine Learning Runs. v1alpha
Package
@google-cloud/hypercomputeclusterConstructors
(constructor)(opts, gaxInstance)
constructor(opts?: ClientOptions, gaxInstance?: typeof gax | typeof gax.fallback);Construct an instance of MachineLearningRunsClient.
| Parameters | |
|---|---|
| Name | Description |
opts |
ClientOptions
|
gaxInstance |
typeof gax | typeof fallback
: loaded instance of |
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;innerApiCalls
innerApiCalls: {
[name: string]: Function;
};locationsClient
locationsClient: LocationsClient;machineLearningRunsStub
machineLearningRunsStub?: Promise<{
[name: string]: Function;
}>;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
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> |
|
const client = longrunning.operationsClient();
await client.cancelOperation({name: ''});
checkCreateMachineLearningRunProgress(name)
checkCreateMachineLearningRunProgress(name: string): Promise<LROperation<protos.google.cloud.hypercomputecluster.v1alpha.MachineLearningRun, protos.google.cloud.hypercomputecluster.v1alpha.OperationMetadata>>;Check the status of the long running operation returned by createMachineLearningRun().
| Parameter | |
|---|---|
| Name | Description |
name |
string
The operation name that will be passed. |
| Returns | |
|---|---|
| Type | Description |
Promise<LROperation<protos.google.cloud.hypercomputecluster.v1alpha.MachineLearningRun, protos.google.cloud.hypercomputecluster.v1alpha.OperationMetadata>> |
{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. |
/**
* 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. Parent format: projects/{project}/locations/{location}
*/
// const parent = 'abc123'
/**
* Required. The Machine Learning Run to create.
*/
// const machineLearningRun = {}
/**
* Optional. The ID of the Machine Learning Run to create.
*/
// const machineLearningRunId = 'abc123'
// Imports the Hypercomputecluster library
const {MachineLearningRunsClient} = require('@google-cloud/hypercomputecluster').v1alpha;
// Instantiates a client
const hypercomputeclusterClient = new MachineLearningRunsClient();
async function callCreateMachineLearningRun() {
// Construct request
const request = {
parent,
machineLearningRun,
};
// Run request
const [operation] = await hypercomputeclusterClient.createMachineLearningRun(request);
const [response] = await operation.promise();
console.log(response);
}
callCreateMachineLearningRun();
checkDeleteMachineLearningRunProgress(name)
checkDeleteMachineLearningRunProgress(name: string): Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.hypercomputecluster.v1alpha.OperationMetadata>>;Check the status of the long running operation returned by deleteMachineLearningRun().
| Parameter | |
|---|---|
| Name | Description |
name |
string
The operation name that will be passed. |
| Returns | |
|---|---|
| Type | Description |
Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.hypercomputecluster.v1alpha.OperationMetadata>> |
{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. |
/**
* 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.
* projects/{project}/locations/{location}/machineLearningRuns/{machineLearningRun}
*/
// const name = 'abc123'
/**
* Optional. Etag for the run. Etag gets updated with every update/create
* operation. If provided, it must match the server's etag.
*/
// const etag = 'abc123'
// Imports the Hypercomputecluster library
const {MachineLearningRunsClient} = require('@google-cloud/hypercomputecluster').v1alpha;
// Instantiates a client
const hypercomputeclusterClient = new MachineLearningRunsClient();
async function callDeleteMachineLearningRun() {
// Construct request
const request = {
name,
};
// Run request
const [operation] = await hypercomputeclusterClient.deleteMachineLearningRun(request);
const [response] = await operation.promise();
console.log(response);
}
callDeleteMachineLearningRun();
checkUpdateMachineLearningRunProgress(name)
checkUpdateMachineLearningRunProgress(name: string): Promise<LROperation<protos.google.cloud.hypercomputecluster.v1alpha.MachineLearningRun, protos.google.cloud.hypercomputecluster.v1alpha.OperationMetadata>>;Check the status of the long running operation returned by updateMachineLearningRun().
| Parameter | |
|---|---|
| Name | Description |
name |
string
The operation name that will be passed. |
| Returns | |
|---|---|
| Type | Description |
Promise<LROperation<protos.google.cloud.hypercomputecluster.v1alpha.MachineLearningRun, protos.google.cloud.hypercomputecluster.v1alpha.OperationMetadata>> |
{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. |
/**
* 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 Machine Learning Run to update.
*/
// const machineLearningRun = {}
/**
* Optional. Used to identify fields to be updated. Allowed fields is *, we
* don't support partial updates.
*/
// const updateMask = {}
// Imports the Hypercomputecluster library
const {MachineLearningRunsClient} = require('@google-cloud/hypercomputecluster').v1alpha;
// Instantiates a client
const hypercomputeclusterClient = new MachineLearningRunsClient();
async function callUpdateMachineLearningRun() {
// Construct request
const request = {
machineLearningRun,
};
// Run request
const [operation] = await hypercomputeclusterClient.updateMachineLearningRun(request);
const [response] = await operation.promise();
console.log(response);
}
callUpdateMachineLearningRun();
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. |
clusterPath(project, location, cluster)
clusterPath(project: string, location: string, cluster: string): string;Return a fully-qualified cluster resource name string.
| Parameters | |
|---|---|
| Name | Description |
project |
string
|
location |
string
|
cluster |
string
|
| Returns | |
|---|---|
| Type | Description |
string |
{string} Resource name string. |
createMachineLearningRun(request, options)
createMachineLearningRun(request?: protos.google.cloud.hypercomputecluster.v1alpha.ICreateMachineLearningRunRequest, options?: CallOptions): Promise<[
LROperation<protos.google.cloud.hypercomputecluster.v1alpha.IMachineLearningRun, protos.google.cloud.hypercomputecluster.v1alpha.IOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]>;Creates a Machine Learning Run.
| Parameters | |
|---|---|
| Name | Description |
request |
ICreateMachineLearningRunRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
| Returns | |
|---|---|
| Type | Description |
Promise<[
LROperation<protos.google.cloud.hypercomputecluster.v1alpha.IMachineLearningRun, protos.google.cloud.hypercomputecluster.v1alpha.IOperationMetadata>,
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 |
/**
* 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. Parent format: projects/{project}/locations/{location}
*/
// const parent = 'abc123'
/**
* Required. The Machine Learning Run to create.
*/
// const machineLearningRun = {}
/**
* Optional. The ID of the Machine Learning Run to create.
*/
// const machineLearningRunId = 'abc123'
// Imports the Hypercomputecluster library
const {MachineLearningRunsClient} = require('@google-cloud/hypercomputecluster').v1alpha;
// Instantiates a client
const hypercomputeclusterClient = new MachineLearningRunsClient();
async function callCreateMachineLearningRun() {
// Construct request
const request = {
parent,
machineLearningRun,
};
// Run request
const [operation] = await hypercomputeclusterClient.createMachineLearningRun(request);
const [response] = await operation.promise();
console.log(response);
}
callCreateMachineLearningRun();
createMachineLearningRun(request, options, callback)
createMachineLearningRun(request: protos.google.cloud.hypercomputecluster.v1alpha.ICreateMachineLearningRunRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.hypercomputecluster.v1alpha.IMachineLearningRun, protos.google.cloud.hypercomputecluster.v1alpha.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;| Parameters | |
|---|---|
| Name | Description |
request |
ICreateMachineLearningRunRequest
|
options |
CallOptions
|
callback |
Callback<LROperation<protos.google.cloud.hypercomputecluster.v1alpha.IMachineLearningRun, protos.google.cloud.hypercomputecluster.v1alpha.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
| Returns | |
|---|---|
| Type | Description |
void |
|
createMachineLearningRun(request, callback)
createMachineLearningRun(request: protos.google.cloud.hypercomputecluster.v1alpha.ICreateMachineLearningRunRequest, callback: Callback<LROperation<protos.google.cloud.hypercomputecluster.v1alpha.IMachineLearningRun, protos.google.cloud.hypercomputecluster.v1alpha.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;| Parameters | |
|---|---|
| Name | Description |
request |
ICreateMachineLearningRunRequest
|
callback |
Callback<LROperation<protos.google.cloud.hypercomputecluster.v1alpha.IMachineLearningRun, protos.google.cloud.hypercomputecluster.v1alpha.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
| Returns | |
|---|---|
| Type | Description |
void |
|
deleteMachineLearningRun(request, options)
deleteMachineLearningRun(request?: protos.google.cloud.hypercomputecluster.v1alpha.IDeleteMachineLearningRunRequest, options?: CallOptions): Promise<[
LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.hypercomputecluster.v1alpha.IOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]>;Deletes a Machine Learning Run.
| Parameters | |
|---|---|
| Name | Description |
request |
IDeleteMachineLearningRunRequest
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.hypercomputecluster.v1alpha.IOperationMetadata>,
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 |
/**
* 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.
* projects/{project}/locations/{location}/machineLearningRuns/{machineLearningRun}
*/
// const name = 'abc123'
/**
* Optional. Etag for the run. Etag gets updated with every update/create
* operation. If provided, it must match the server's etag.
*/
// const etag = 'abc123'
// Imports the Hypercomputecluster library
const {MachineLearningRunsClient} = require('@google-cloud/hypercomputecluster').v1alpha;
// Instantiates a client
const hypercomputeclusterClient = new MachineLearningRunsClient();
async function callDeleteMachineLearningRun() {
// Construct request
const request = {
name,
};
// Run request
const [operation] = await hypercomputeclusterClient.deleteMachineLearningRun(request);
const [response] = await operation.promise();
console.log(response);
}
callDeleteMachineLearningRun();
deleteMachineLearningRun(request, options, callback)
deleteMachineLearningRun(request: protos.google.cloud.hypercomputecluster.v1alpha.IDeleteMachineLearningRunRequest, options: CallOptions, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.hypercomputecluster.v1alpha.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;| Parameters | |
|---|---|
| Name | Description |
request |
IDeleteMachineLearningRunRequest
|
options |
CallOptions
|
callback |
Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.hypercomputecluster.v1alpha.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
| Returns | |
|---|---|
| Type | Description |
void |
|
deleteMachineLearningRun(request, callback)
deleteMachineLearningRun(request: protos.google.cloud.hypercomputecluster.v1alpha.IDeleteMachineLearningRunRequest, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.hypercomputecluster.v1alpha.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;| Parameters | |
|---|---|
| Name | Description |
request |
IDeleteMachineLearningRunRequest
|
callback |
Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.hypercomputecluster.v1alpha.IOperationMetadata>, 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> |
|
const client = longrunning.operationsClient();
await client.deleteOperation({name: ''});
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. |
const [response] = await client.getLocation(request);
getMachineLearningRun(request, options)
getMachineLearningRun(request?: protos.google.cloud.hypercomputecluster.v1alpha.IGetMachineLearningRunRequest, options?: CallOptions): Promise<[
protos.google.cloud.hypercomputecluster.v1alpha.IMachineLearningRun,
protos.google.cloud.hypercomputecluster.v1alpha.IGetMachineLearningRunRequest | undefined,
{} | undefined
]>;Gets a Machine Learning Run.
| Parameters | |
|---|---|
| Name | Description |
request |
IGetMachineLearningRunRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
| Returns | |
|---|---|
| Type | Description |
Promise<[
protos.google.cloud.hypercomputecluster.v1alpha.IMachineLearningRun,
protos.google.cloud.hypercomputecluster.v1alpha.IGetMachineLearningRunRequest | undefined,
{} | undefined
]> |
{Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the documentation for more details and examples. |
/**
* 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.
* projects/{project}/locations/{location}/machineLearningRuns/{machineLearningRun}
*/
// const name = 'abc123'
// Imports the Hypercomputecluster library
const {MachineLearningRunsClient} = require('@google-cloud/hypercomputecluster').v1alpha;
// Instantiates a client
const hypercomputeclusterClient = new MachineLearningRunsClient();
async function callGetMachineLearningRun() {
// Construct request
const request = {
name,
};
// Run request
const response = await hypercomputeclusterClient.getMachineLearningRun(request);
console.log(response);
}
callGetMachineLearningRun();
getMachineLearningRun(request, options, callback)
getMachineLearningRun(request: protos.google.cloud.hypercomputecluster.v1alpha.IGetMachineLearningRunRequest, options: CallOptions, callback: Callback<protos.google.cloud.hypercomputecluster.v1alpha.IMachineLearningRun, protos.google.cloud.hypercomputecluster.v1alpha.IGetMachineLearningRunRequest | null | undefined, {} | null | undefined>): void;| Parameters | |
|---|---|
| Name | Description |
request |
IGetMachineLearningRunRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.cloud.hypercomputecluster.v1alpha.IMachineLearningRun, protos.google.cloud.hypercomputecluster.v1alpha.IGetMachineLearningRunRequest | null | undefined, {} | null | undefined>
|
| Returns | |
|---|---|
| Type | Description |
void |
|
getMachineLearningRun(request, callback)
getMachineLearningRun(request: protos.google.cloud.hypercomputecluster.v1alpha.IGetMachineLearningRunRequest, callback: Callback<protos.google.cloud.hypercomputecluster.v1alpha.IMachineLearningRun, protos.google.cloud.hypercomputecluster.v1alpha.IGetMachineLearningRunRequest | null | undefined, {} | null | undefined>): void;| Parameters | |
|---|---|
| Name | Description |
request |
IGetMachineLearningRunRequest
|
callback |
Callback<protos.google.cloud.hypercomputecluster.v1alpha.IMachineLearningRun, protos.google.cloud.hypercomputecluster.v1alpha.IGetMachineLearningRunRequest | null | undefined, {} | null | undefined>
|
| Returns | |
|---|---|
| Type | Description |
void |
|
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]> |
|
const client = longrunning.operationsClient();
const name = '';
const [response] = await client.getOperation({name});
// doThingsWith(response)
getProfileSession(request, options)
getProfileSession(request?: protos.google.cloud.hypercomputecluster.v1alpha.IGetProfileSessionRequest, options?: CallOptions): Promise<[
protos.google.cloud.hypercomputecluster.v1alpha.IProfileSession,
protos.google.cloud.hypercomputecluster.v1alpha.IGetProfileSessionRequest | undefined,
{} | undefined
]>;Gets a Profile Session.
| Parameters | |
|---|---|
| Name | Description |
request |
IGetProfileSessionRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
| Returns | |
|---|---|
| Type | Description |
Promise<[
protos.google.cloud.hypercomputecluster.v1alpha.IProfileSession,
protos.google.cloud.hypercomputecluster.v1alpha.IGetProfileSessionRequest | undefined,
{} | undefined
]> |
{Promise} - The promise which resolves to an array. The first element of the array is an object representing ProfileSession. Please see the documentation for more details and examples. |
/**
* 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.
* projects/{project}/locations/{location}/machineLearningRuns/{machineLearningRun}/profileSessions/{profileSession}
*/
// const name = 'abc123'
// Imports the Hypercomputecluster library
const {MachineLearningRunsClient} = require('@google-cloud/hypercomputecluster').v1alpha;
// Instantiates a client
const hypercomputeclusterClient = new MachineLearningRunsClient();
async function callGetProfileSession() {
// Construct request
const request = {
name,
};
// Run request
const response = await hypercomputeclusterClient.getProfileSession(request);
console.log(response);
}
callGetProfileSession();
getProfileSession(request, options, callback)
getProfileSession(request: protos.google.cloud.hypercomputecluster.v1alpha.IGetProfileSessionRequest, options: CallOptions, callback: Callback<protos.google.cloud.hypercomputecluster.v1alpha.IProfileSession, protos.google.cloud.hypercomputecluster.v1alpha.IGetProfileSessionRequest | null | undefined, {} | null | undefined>): void;| Parameters | |
|---|---|
| Name | Description |
request |
IGetProfileSessionRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.cloud.hypercomputecluster.v1alpha.IProfileSession, protos.google.cloud.hypercomputecluster.v1alpha.IGetProfileSessionRequest | null | undefined, {} | null | undefined>
|
| Returns | |
|---|---|
| Type | Description |
void |
|
getProfileSession(request, callback)
getProfileSession(request: protos.google.cloud.hypercomputecluster.v1alpha.IGetProfileSessionRequest, callback: Callback<protos.google.cloud.hypercomputecluster.v1alpha.IProfileSession, protos.google.cloud.hypercomputecluster.v1alpha.IGetProfileSessionRequest | null | undefined, {} | null | undefined>): void;| Parameters | |
|---|---|
| Name | Description |
request |
IGetProfileSessionRequest
|
callback |
Callback<protos.google.cloud.hypercomputecluster.v1alpha.IProfileSession, protos.google.cloud.hypercomputecluster.v1alpha.IGetProfileSessionRequest | null | undefined, {} | null | undefined>
|
| Returns | |
|---|---|
| Type | Description |
void |
|
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 |
|
initialize()
initialize(): Promise<{
[name: string]: Function;
}>;Initialize the client. Performs asynchronous operations (such as authentication) and prepares the client. This function will be called automatically when any class method is called for the first time, but if you need to initialize it before calling an actual method, feel free to call initialize() directly.
You can await on this method if you want to make sure the client is initialized.
| Returns | |
|---|---|
| Type | Description |
Promise<{
[name: string]: Function;
}> |
{Promise} A promise that resolves to an authenticated service stub. |
listLocationsAsync(request, options)
listLocationsAsync(request: LocationProtos.google.cloud.location.IListLocationsRequest, options?: CallOptions): AsyncIterable<LocationProtos.google.cloud.location.ILocation>;Lists information about the supported locations for this service. Returns an iterable object.
for-await-of syntax is used with the iterable to get response elements on-demand.
| Parameters | |
|---|---|
| Name | Description |
request |
LocationProtos.google.cloud.location.IListLocationsRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
| Returns | |
|---|---|
| Type | Description |
AsyncIterable<google.cloud.location.ILocation> |
{Object} An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing . The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the documentation for more details and examples. |
const iterable = client.listLocationsAsync(request);
for await (const response of iterable) {
// process response
}
listMachineLearningRuns(request, options)
listMachineLearningRuns(request?: protos.google.cloud.hypercomputecluster.v1alpha.IListMachineLearningRunsRequest, options?: CallOptions): Promise<[
protos.google.cloud.hypercomputecluster.v1alpha.IMachineLearningRun[],
protos.google.cloud.hypercomputecluster.v1alpha.IListMachineLearningRunsRequest | null,
protos.google.cloud.hypercomputecluster.v1alpha.IListMachineLearningRunsResponse
]>;Lists Machine Learning Runs.
| Parameters | |
|---|---|
| Name | Description |
request |
IListMachineLearningRunsRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
| Returns | |
|---|---|
| Type | Description |
Promise<[
protos.google.cloud.hypercomputecluster.v1alpha.IMachineLearningRun[],
protos.google.cloud.hypercomputecluster.v1alpha.IListMachineLearningRunsRequest | null,
protos.google.cloud.hypercomputecluster.v1alpha.IListMachineLearningRunsResponse
]> |
{Promise} - The promise which resolves to an array. The first element of the array is Array of . 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 |
listMachineLearningRuns(request, options, callback)
listMachineLearningRuns(request: protos.google.cloud.hypercomputecluster.v1alpha.IListMachineLearningRunsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.hypercomputecluster.v1alpha.IListMachineLearningRunsRequest, protos.google.cloud.hypercomputecluster.v1alpha.IListMachineLearningRunsResponse | null | undefined, protos.google.cloud.hypercomputecluster.v1alpha.IMachineLearningRun>): void;| Parameters | |
|---|---|
| Name | Description |
request |
IListMachineLearningRunsRequest
|
options |
CallOptions
|
callback |
PaginationCallback<protos.google.cloud.hypercomputecluster.v1alpha.IListMachineLearningRunsRequest, protos.google.cloud.hypercomputecluster.v1alpha.IListMachineLearningRunsResponse | null | undefined, protos.google.cloud.hypercomputecluster.v1alpha.IMachineLearningRun>
|
| Returns | |
|---|---|
| Type | Description |
void |
|
listMachineLearningRuns(request, callback)
listMachineLearningRuns(request: protos.google.cloud.hypercomputecluster.v1alpha.IListMachineLearningRunsRequest, callback: PaginationCallback<protos.google.cloud.hypercomputecluster.v1alpha.IListMachineLearningRunsRequest, protos.google.cloud.hypercomputecluster.v1alpha.IListMachineLearningRunsResponse | null | undefined, protos.google.cloud.hypercomputecluster.v1alpha.IMachineLearningRun>): void;| Parameters | |
|---|---|
| Name | Description |
request |
IListMachineLearningRunsRequest
|
callback |
PaginationCallback<protos.google.cloud.hypercomputecluster.v1alpha.IListMachineLearningRunsRequest, protos.google.cloud.hypercomputecluster.v1alpha.IListMachineLearningRunsResponse | null | undefined, protos.google.cloud.hypercomputecluster.v1alpha.IMachineLearningRun>
|
| Returns | |
|---|---|
| Type | Description |
void |
|
listMachineLearningRunsAsync(request, options)
listMachineLearningRunsAsync(request?: protos.google.cloud.hypercomputecluster.v1alpha.IListMachineLearningRunsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.hypercomputecluster.v1alpha.IMachineLearningRun>;Equivalent to listMachineLearningRuns, but returns an iterable object.
for-await-of syntax is used with the iterable to get response elements on-demand.
| Parameters | |
|---|---|
| Name | Description |
request |
IListMachineLearningRunsRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
| Returns | |
|---|---|
| Type | Description |
AsyncIterable<protos.google.cloud.hypercomputecluster.v1alpha.IMachineLearningRun> |
{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. |
/**
* 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. projects/{project}/locations/{location}
*/
// const parent = 'abc123'
/**
* Optional. The maximum number of Machine Learning Runs to return. The
* service may return fewer than this value. If unspecified, at most 10
* Machine Learning Runs will be returned. The maximum value is 1000; values
* above 1000 will be coerced to 1000. Please refer to
* https://google.aip.dev/158 for more details.
*/
// const pageSize = 1234
/**
* Optional. A page token, received from a previous `ListMachineLearningRuns`
* call. Provide this to retrieve the subsequent page. Please refer to
* https://google.aip.dev/158 for more details.
*/
// const pageToken = 'abc123'
/**
* Optional. An expression for filtering the results of the request.
* Supported filter fields are:
* - run_id (string): The ID of the run (e.g., "run-1").
* - run_set (string): The run set (e.g., "run-set-1").
* - display_name (string): The display name of the run (e.g.,
* "display-name-1").
* - state (enum): The state of the run (e.g., "STATE_COMPLETED").
* - region (string): The region of the run (e.g., "us-central1").
* - orchestrator (enum): The orchestrator used for the run (e.g.,
* "ORCHESTRATOR_GKE").
* - create_time (timestamp): The creation timestamp of the run.
* - update_time (timestamp): The last update timestamp of the run.
* - etag (string): The ETag of the run.
* Filter expressions can be combined using "AND" and "OR" operators.
* Examples:
* To filter by a single field:
* `run_set = "run-set-1"`
* `state = "STATE_ACTIVE"`
* To filter by multiple fields:
* `run_set = "run-set-1" AND state = "STATE_ACTIVE"`
* `region = "us-central1" AND orchestrator = "ORCHESTRATOR_GKE"`
* To filter by timestamp:
* `create_time > "2025-05-26T10:00:00Z"`
*/
// const filter = 'abc123'
/**
* Optional. A comma-separated list of fields to order by, sorted in ascending
* order. Use "desc" after a field name for descending.
* Supported fields:
* * `run_id`
* * `run_set`
* * `display_name`
* * `region`
* * `orchestrator`
* * `state`
* * `create_time`
* * `update_time`
* Example: `update_time desc, create_time`.
*/
// const orderBy = 'abc123'
// Imports the Hypercomputecluster library
const {MachineLearningRunsClient} = require('@google-cloud/hypercomputecluster').v1alpha;
// Instantiates a client
const hypercomputeclusterClient = new MachineLearningRunsClient();
async function callListMachineLearningRuns() {
// Construct request
const request = {
parent,
};
// Run request
const iterable = hypercomputeclusterClient.listMachineLearningRunsAsync(request);
for await (const response of iterable) {
console.log(response);
}
}
callListMachineLearningRuns();
listMachineLearningRunsStream(request, options)
listMachineLearningRunsStream(request?: protos.google.cloud.hypercomputecluster.v1alpha.IListMachineLearningRunsRequest, options?: CallOptions): Transform;Equivalent to listMachineLearningRuns, but returns a NodeJS Stream object.
| Parameters | |
|---|---|
| Name | Description |
request |
IListMachineLearningRunsRequest
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 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 |
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. |
const client = longrunning.operationsClient();
for await (const response of client.listOperationsAsync(request));
// doThingsWith(response)
listProfileSessions(request, options)
listProfileSessions(request?: protos.google.cloud.hypercomputecluster.v1alpha.IListProfileSessionsRequest, options?: CallOptions): Promise<[
protos.google.cloud.hypercomputecluster.v1alpha.IProfileSession[],
protos.google.cloud.hypercomputecluster.v1alpha.IListProfileSessionsRequest | null,
protos.google.cloud.hypercomputecluster.v1alpha.IListProfileSessionsResponse
]>;Lists Profile Sessions for a Machine Learning Run.
| Parameters | |
|---|---|
| Name | Description |
request |
IListProfileSessionsRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
| Returns | |
|---|---|
| Type | Description |
Promise<[
protos.google.cloud.hypercomputecluster.v1alpha.IProfileSession[],
protos.google.cloud.hypercomputecluster.v1alpha.IListProfileSessionsRequest | null,
protos.google.cloud.hypercomputecluster.v1alpha.IListProfileSessionsResponse
]> |
{Promise} - The promise which resolves to an array. The first element of the array is Array of ProfileSession. 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 |
listProfileSessions(request, options, callback)
listProfileSessions(request: protos.google.cloud.hypercomputecluster.v1alpha.IListProfileSessionsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.hypercomputecluster.v1alpha.IListProfileSessionsRequest, protos.google.cloud.hypercomputecluster.v1alpha.IListProfileSessionsResponse | null | undefined, protos.google.cloud.hypercomputecluster.v1alpha.IProfileSession>): void;| Parameters | |
|---|---|
| Name | Description |
request |
IListProfileSessionsRequest
|
options |
CallOptions
|
callback |
PaginationCallback<protos.google.cloud.hypercomputecluster.v1alpha.IListProfileSessionsRequest, protos.google.cloud.hypercomputecluster.v1alpha.IListProfileSessionsResponse | null | undefined, protos.google.cloud.hypercomputecluster.v1alpha.IProfileSession>
|
| Returns | |
|---|---|
| Type | Description |
void |
|
listProfileSessions(request, callback)
listProfileSessions(request: protos.google.cloud.hypercomputecluster.v1alpha.IListProfileSessionsRequest, callback: PaginationCallback<protos.google.cloud.hypercomputecluster.v1alpha.IListProfileSessionsRequest, protos.google.cloud.hypercomputecluster.v1alpha.IListProfileSessionsResponse | null | undefined, protos.google.cloud.hypercomputecluster.v1alpha.IProfileSession>): void;| Parameters | |
|---|---|
| Name | Description |
request |
IListProfileSessionsRequest
|
callback |
PaginationCallback<protos.google.cloud.hypercomputecluster.v1alpha.IListProfileSessionsRequest, protos.google.cloud.hypercomputecluster.v1alpha.IListProfileSessionsResponse | null | undefined, protos.google.cloud.hypercomputecluster.v1alpha.IProfileSession>
|
| Returns | |
|---|---|
| Type | Description |
void |
|
listProfileSessionsAsync(request, options)
listProfileSessionsAsync(request?: protos.google.cloud.hypercomputecluster.v1alpha.IListProfileSessionsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.hypercomputecluster.v1alpha.IProfileSession>;Equivalent to listProfileSessions, but returns an iterable object.
for-await-of syntax is used with the iterable to get response elements on-demand.
| Parameters | |
|---|---|
| Name | Description |
request |
IListProfileSessionsRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
| Returns | |
|---|---|
| Type | Description |
AsyncIterable<protos.google.cloud.hypercomputecluster.v1alpha.IProfileSession> |
{Object} An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing ProfileSession. 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. |
/**
* 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. Parent format:
* projects/{project}/locations/{location}/machineLearningRuns/{machineLearningRun}
*/
// const parent = 'abc123'
/**
* Optional. The maximum number of Profile Sessions to return. The service may
* return fewer than this value.
* If unspecified, at most 50 Profile Sessions will be returned.
* The maximum value is 1000; values above 1000 will be coerced to 1000.
*/
// const pageSize = 1234
/**
* Optional. A page token, received from a previous `ListProfileSessions`
* call. Provide this to retrieve the subsequent page.
*/
// const pageToken = 'abc123'
// Imports the Hypercomputecluster library
const {MachineLearningRunsClient} = require('@google-cloud/hypercomputecluster').v1alpha;
// Instantiates a client
const hypercomputeclusterClient = new MachineLearningRunsClient();
async function callListProfileSessions() {
// Construct request
const request = {
parent,
};
// Run request
const iterable = hypercomputeclusterClient.listProfileSessionsAsync(request);
for await (const response of iterable) {
console.log(response);
}
}
callListProfileSessions();
listProfileSessionsStream(request, options)
listProfileSessionsStream(request?: protos.google.cloud.hypercomputecluster.v1alpha.IListProfileSessionsRequest, options?: CallOptions): Transform;Equivalent to listProfileSessions, but returns a NodeJS Stream object.
| Parameters | |
|---|---|
| Name | Description |
request |
IListProfileSessionsRequest
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 ProfileSession 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 |
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. |
machineLearningRunPath(project, location, machineLearningRun)
machineLearningRunPath(project: string, location: string, machineLearningRun: string): string;Return a fully-qualified machineLearningRun resource name string.
| Parameters | |
|---|---|
| Name | Description |
project |
string
|
location |
string
|
machineLearningRun |
string
|
| Returns | |
|---|---|
| Type | Description |
string |
{string} Resource name string. |
matchClusterFromClusterName(clusterName)
matchClusterFromClusterName(clusterName: string): string | number;Parse the cluster from Cluster resource.
| Parameter | |
|---|---|
| Name | Description |
clusterName |
string
A fully-qualified path representing Cluster resource. |
| Returns | |
|---|---|
| Type | Description |
string | number |
{string} A string representing the cluster. |
matchLocationFromClusterName(clusterName)
matchLocationFromClusterName(clusterName: string): string | number;Parse the location from Cluster resource.
| Parameter | |
|---|---|
| Name | Description |
clusterName |
string
A fully-qualified path representing Cluster 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. |
matchLocationFromMachineLearningRunName(machineLearningRunName)
matchLocationFromMachineLearningRunName(machineLearningRunName: string): string | number;Parse the location from MachineLearningRun resource.
| Parameter | |
|---|---|
| Name | Description |
machineLearningRunName |
string
A fully-qualified path representing MachineLearningRun resource. |
| Returns | |
|---|---|
| Type | Description |
string | number |
{string} A string representing the location. |
matchLocationFromProfileSessionName(profileSessionName)
matchLocationFromProfileSessionName(profileSessionName: string): string | number;Parse the location from ProfileSession resource.
| Parameter | |
|---|---|
| Name | Description |
profileSessionName |
string
A fully-qualified path representing ProfileSession resource. |
| Returns | |
|---|---|
| Type | Description |
string | number |
{string} A string representing the location. |
matchMachineLearningRunFromMachineLearningRunName(machineLearningRunName)
matchMachineLearningRunFromMachineLearningRunName(machineLearningRunName: string): string | number;Parse the machine_learning_run from MachineLearningRun resource.
| Parameter | |
|---|---|
| Name | Description |
machineLearningRunName |
string
A fully-qualified path representing MachineLearningRun resource. |
| Returns | |
|---|---|
| Type | Description |
string | number |
{string} A string representing the machine_learning_run. |
matchMachineLearningRunFromProfileSessionName(profileSessionName)
matchMachineLearningRunFromProfileSessionName(profileSessionName: string): string | number;Parse the machine_learning_run from ProfileSession resource.
| Parameter | |
|---|---|
| Name | Description |
profileSessionName |
string
A fully-qualified path representing ProfileSession resource. |
| Returns | |
|---|---|
| Type | Description |
string | number |
{string} A string representing the machine_learning_run. |
matchProfileSessionFromProfileSessionName(profileSessionName)
matchProfileSessionFromProfileSessionName(profileSessionName: string): string | number;Parse the profile_session from ProfileSession resource.
| Parameter | |
|---|---|
| Name | Description |
profileSessionName |
string
A fully-qualified path representing ProfileSession resource. |
| Returns | |
|---|---|
| Type | Description |
string | number |
{string} A string representing the profile_session. |
matchProjectFromClusterName(clusterName)
matchProjectFromClusterName(clusterName: string): string | number;Parse the project from Cluster resource.
| Parameter | |
|---|---|
| Name | Description |
clusterName |
string
A fully-qualified path representing Cluster resource. |
| Returns | |
|---|---|
| Type | Description |
string | number |
{string} A string representing the project. |
matchProjectFromLocationName(locationName)
matchProjectFromLocationName(locationName: string): string | number;Parse the project from Location resource.
| Parameter | |
|---|---|
| Name | Description |
locationName |
string
A fully-qualified path representing Location resource. |
| Returns | |
|---|---|
| Type | Description |
string | number |
{string} A string representing the project. |
matchProjectFromMachineLearningRunName(machineLearningRunName)
matchProjectFromMachineLearningRunName(machineLearningRunName: string): string | number;Parse the project from MachineLearningRun resource.
| Parameter | |
|---|---|
| Name | Description |
machineLearningRunName |
string
A fully-qualified path representing MachineLearningRun resource. |
| Returns | |
|---|---|
| Type | Description |
string | number |
{string} A string representing the project. |
matchProjectFromProfileSessionName(profileSessionName)
matchProjectFromProfileSessionName(profileSessionName: string): string | number;Parse the project from ProfileSession resource.
| Parameter | |
|---|---|
| Name | Description |
profileSessionName |
string
A fully-qualified path representing ProfileSession resource. |
| Returns | |
|---|---|
| Type | Description |
string | number |
{string} A string representing the project. |
matchProjectFromProjectName(projectName)
matchProjectFromProjectName(projectName: string): string | number;Parse the project from Project resource.
| Parameter | |
|---|---|
| Name | Description |
projectName |
string
A fully-qualified path representing Project resource. |
| Returns | |
|---|---|
| Type | Description |
string | number |
{string} A string representing the project. |
profileSessionPath(project, location, machineLearningRun, profileSession)
profileSessionPath(project: string, location: string, machineLearningRun: string, profileSession: string): string;Return a fully-qualified profileSession resource name string.
| Parameters | |
|---|---|
| Name | Description |
project |
string
|
location |
string
|
machineLearningRun |
string
|
profileSession |
string
|
| Returns | |
|---|---|
| Type | Description |
string |
{string} Resource name string. |
projectPath(project)
projectPath(project: string): string;Return a fully-qualified project resource name string.
| Parameter | |
|---|---|
| Name | Description |
project |
string
|
| Returns | |
|---|---|
| Type | Description |
string |
{string} Resource name string. |
updateMachineLearningRun(request, options)
updateMachineLearningRun(request?: protos.google.cloud.hypercomputecluster.v1alpha.IUpdateMachineLearningRunRequest, options?: CallOptions): Promise<[
LROperation<protos.google.cloud.hypercomputecluster.v1alpha.IMachineLearningRun, protos.google.cloud.hypercomputecluster.v1alpha.IOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]>;Updates an Machine Learning Run.
| Parameters | |
|---|---|
| Name | Description |
request |
IUpdateMachineLearningRunRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
| Returns | |
|---|---|
| Type | Description |
Promise<[
LROperation<protos.google.cloud.hypercomputecluster.v1alpha.IMachineLearningRun, protos.google.cloud.hypercomputecluster.v1alpha.IOperationMetadata>,
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 |
/**
* 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 Machine Learning Run to update.
*/
// const machineLearningRun = {}
/**
* Optional. Used to identify fields to be updated. Allowed fields is *, we
* don't support partial updates.
*/
// const updateMask = {}
// Imports the Hypercomputecluster library
const {MachineLearningRunsClient} = require('@google-cloud/hypercomputecluster').v1alpha;
// Instantiates a client
const hypercomputeclusterClient = new MachineLearningRunsClient();
async function callUpdateMachineLearningRun() {
// Construct request
const request = {
machineLearningRun,
};
// Run request
const [operation] = await hypercomputeclusterClient.updateMachineLearningRun(request);
const [response] = await operation.promise();
console.log(response);
}
callUpdateMachineLearningRun();
updateMachineLearningRun(request, options, callback)
updateMachineLearningRun(request: protos.google.cloud.hypercomputecluster.v1alpha.IUpdateMachineLearningRunRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.hypercomputecluster.v1alpha.IMachineLearningRun, protos.google.cloud.hypercomputecluster.v1alpha.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;| Parameters | |
|---|---|
| Name | Description |
request |
IUpdateMachineLearningRunRequest
|
options |
CallOptions
|
callback |
Callback<LROperation<protos.google.cloud.hypercomputecluster.v1alpha.IMachineLearningRun, protos.google.cloud.hypercomputecluster.v1alpha.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
| Returns | |
|---|---|
| Type | Description |
void |
|
updateMachineLearningRun(request, callback)
updateMachineLearningRun(request: protos.google.cloud.hypercomputecluster.v1alpha.IUpdateMachineLearningRunRequest, callback: Callback<LROperation<protos.google.cloud.hypercomputecluster.v1alpha.IMachineLearningRun, protos.google.cloud.hypercomputecluster.v1alpha.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;| Parameters | |
|---|---|
| Name | Description |
request |
IUpdateMachineLearningRunRequest
|
callback |
Callback<LROperation<protos.google.cloud.hypercomputecluster.v1alpha.IMachineLearningRun, protos.google.cloud.hypercomputecluster.v1alpha.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
| Returns | |
|---|---|
| Type | Description |
void |
|