Class v1.AssuredWorkloadsServiceClient (3.4.0)

Service to manage AssuredWorkloads. v1

Package

@google-cloud/assured-workloads

Constructors

(constructor)(opts)

constructor(opts?: ClientOptions);

Construct an instance of AssuredWorkloadsServiceClient.

Parameter
NameDescription
opts ClientOptions

Properties

apiEndpoint

static get apiEndpoint(): string;

The DNS address for this API service - same as servicePath(), exists for compatibility reasons.

assuredWorkloadsServiceStub

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

auth

auth: gax.GoogleAuth;

descriptors

descriptors: Descriptors;

innerApiCalls

innerApiCalls: {
        [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.

warn

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

Methods

checkCreateWorkloadProgress(name)

checkCreateWorkloadProgress(name: string): Promise<LROperation<protos.google.cloud.assuredworkloads.v1.Workload, protos.google.cloud.assuredworkloads.v1.CreateWorkloadOperationMetadata>>;

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

Parameter
NameDescription
name string

The operation name that will be passed.

Returns
TypeDescription
Promise<LROperation<protos.google.cloud.assuredworkloads.v1.Workload, protos.google.cloud.assuredworkloads.v1.CreateWorkloadOperationMetadata>>

{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

Example

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The resource name of the new Workload's parent.
   *  Must be of the form `organizations/{org_id}/locations/{location_id}`.
   */
  // const parent = 'abc123'
  /**
   *  Required. Assured Workload to create
   */
  // const workload = {}
  /**
   *  Optional. A identifier associated with the workload and underlying projects
   *  which allows for the break down of billing costs for a workload. The value
   *  provided for the identifier will add a label to the workload and contained
   *  projects with the identifier as the value.
   */
  // const externalId = 'abc123'

  // Imports the Assuredworkloads library
  const {AssuredWorkloadsServiceClient} = require('@google-cloud/assured-workloads').v1;

  // Instantiates a client
  const assuredworkloadsClient = new AssuredWorkloadsServiceClient();

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

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

  callCreateWorkload();

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
TypeDescription
Promise<void>

{Promise} A promise that resolves when the client is closed.

createWorkload(request, options)

createWorkload(request?: protos.google.cloud.assuredworkloads.v1.ICreateWorkloadRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.assuredworkloads.v1.IWorkload, protos.google.cloud.assuredworkloads.v1.ICreateWorkloadOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Creates Assured Workload.

Parameters
NameDescription
request protos.google.cloud.assuredworkloads.v1.ICreateWorkloadRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ LROperation<protos.google.cloud.assuredworkloads.v1.IWorkload, protos.google.cloud.assuredworkloads.v1.ICreateWorkloadOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its promise() method returns a promise you can await for. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

Example

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The resource name of the new Workload's parent.
   *  Must be of the form `organizations/{org_id}/locations/{location_id}`.
   */
  // const parent = 'abc123'
  /**
   *  Required. Assured Workload to create
   */
  // const workload = {}
  /**
   *  Optional. A identifier associated with the workload and underlying projects
   *  which allows for the break down of billing costs for a workload. The value
   *  provided for the identifier will add a label to the workload and contained
   *  projects with the identifier as the value.
   */
  // const externalId = 'abc123'

  // Imports the Assuredworkloads library
  const {AssuredWorkloadsServiceClient} = require('@google-cloud/assured-workloads').v1;

  // Instantiates a client
  const assuredworkloadsClient = new AssuredWorkloadsServiceClient();

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

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

  callCreateWorkload();

createWorkload(request, options, callback)

createWorkload(request: protos.google.cloud.assuredworkloads.v1.ICreateWorkloadRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.assuredworkloads.v1.IWorkload, protos.google.cloud.assuredworkloads.v1.ICreateWorkloadOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.assuredworkloads.v1.ICreateWorkloadRequest
options CallOptions
callback Callback<LROperation<protos.google.cloud.assuredworkloads.v1.IWorkload, protos.google.cloud.assuredworkloads.v1.ICreateWorkloadOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

createWorkload(request, callback)

createWorkload(request: protos.google.cloud.assuredworkloads.v1.ICreateWorkloadRequest, callback: Callback<LROperation<protos.google.cloud.assuredworkloads.v1.IWorkload, protos.google.cloud.assuredworkloads.v1.ICreateWorkloadOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.assuredworkloads.v1.ICreateWorkloadRequest
callback Callback<LROperation<protos.google.cloud.assuredworkloads.v1.IWorkload, protos.google.cloud.assuredworkloads.v1.ICreateWorkloadOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

deleteWorkload(request, options)

deleteWorkload(request?: protos.google.cloud.assuredworkloads.v1.IDeleteWorkloadRequest, options?: CallOptions): Promise<[
        protos.google.protobuf.IEmpty,
        (protos.google.cloud.assuredworkloads.v1.IDeleteWorkloadRequest | undefined),
        {} | undefined
    ]>;

Deletes the workload. Make sure that workload's direct children are already in a deleted state, otherwise the request will fail with a FAILED_PRECONDITION error.

Parameters
NameDescription
request protos.google.cloud.assuredworkloads.v1.IDeleteWorkloadRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.protobuf.IEmpty, (protos.google.cloud.assuredworkloads.v1.IDeleteWorkloadRequest | undefined), {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing [Empty]. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples.

Example

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The `name` field is used to identify the workload.
   *  Format:
   *  organizations/{org_id}/locations/{location_id}/workloads/{workload_id}
   */
  // const name = 'abc123'
  /**
   *  Optional. The etag of the workload.
   *  If this is provided, it must match the server's etag.
   */
  // const etag = 'abc123'

  // Imports the Assuredworkloads library
  const {AssuredWorkloadsServiceClient} = require('@google-cloud/assured-workloads').v1;

  // Instantiates a client
  const assuredworkloadsClient = new AssuredWorkloadsServiceClient();

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

    // Run request
    const response = await assuredworkloadsClient.deleteWorkload(request);
    console.log(response);
  }

  callDeleteWorkload();

deleteWorkload(request, options, callback)

deleteWorkload(request: protos.google.cloud.assuredworkloads.v1.IDeleteWorkloadRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.assuredworkloads.v1.IDeleteWorkloadRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.assuredworkloads.v1.IDeleteWorkloadRequest
options CallOptions
callback Callback<protos.google.protobuf.IEmpty, protos.google.cloud.assuredworkloads.v1.IDeleteWorkloadRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

deleteWorkload(request, callback)

deleteWorkload(request: protos.google.cloud.assuredworkloads.v1.IDeleteWorkloadRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.assuredworkloads.v1.IDeleteWorkloadRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.assuredworkloads.v1.IDeleteWorkloadRequest
callback Callback<protos.google.protobuf.IEmpty, protos.google.cloud.assuredworkloads.v1.IDeleteWorkloadRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

getProjectId()

getProjectId(): Promise<string>;
Returns
TypeDescription
Promise<string>

getProjectId(callback)

getProjectId(callback: Callback<string, undefined, undefined>): void;
Parameter
NameDescription
callback Callback<string, undefined, undefined>
Returns
TypeDescription
void

getWorkload(request, options)

getWorkload(request?: protos.google.cloud.assuredworkloads.v1.IGetWorkloadRequest, options?: CallOptions): Promise<[
        protos.google.cloud.assuredworkloads.v1.IWorkload,
        protos.google.cloud.assuredworkloads.v1.IGetWorkloadRequest | undefined,
        {} | undefined
    ]>;

Gets Assured Workload associated with a CRM Node

Parameters
NameDescription
request protos.google.cloud.assuredworkloads.v1.IGetWorkloadRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.cloud.assuredworkloads.v1.IWorkload, protos.google.cloud.assuredworkloads.v1.IGetWorkloadRequest | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing [Workload]. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples.

Example

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The resource name of the Workload to fetch. This is the
   *  workloads's relative path in the API, formatted as
   *  "organizations/{organization_id}/locations/{location_id}/workloads/{workload_id}".
   *  For example,
   *  "organizations/123/locations/us-east1/workloads/assured-workload-1".
   */
  // const name = 'abc123'

  // Imports the Assuredworkloads library
  const {AssuredWorkloadsServiceClient} = require('@google-cloud/assured-workloads').v1;

  // Instantiates a client
  const assuredworkloadsClient = new AssuredWorkloadsServiceClient();

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

    // Run request
    const response = await assuredworkloadsClient.getWorkload(request);
    console.log(response);
  }

  callGetWorkload();

getWorkload(request, options, callback)

getWorkload(request: protos.google.cloud.assuredworkloads.v1.IGetWorkloadRequest, options: CallOptions, callback: Callback<protos.google.cloud.assuredworkloads.v1.IWorkload, protos.google.cloud.assuredworkloads.v1.IGetWorkloadRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.assuredworkloads.v1.IGetWorkloadRequest
options CallOptions
callback Callback<protos.google.cloud.assuredworkloads.v1.IWorkload, protos.google.cloud.assuredworkloads.v1.IGetWorkloadRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

getWorkload(request, callback)

getWorkload(request: protos.google.cloud.assuredworkloads.v1.IGetWorkloadRequest, callback: Callback<protos.google.cloud.assuredworkloads.v1.IWorkload, protos.google.cloud.assuredworkloads.v1.IGetWorkloadRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.assuredworkloads.v1.IGetWorkloadRequest
callback Callback<protos.google.cloud.assuredworkloads.v1.IWorkload, protos.google.cloud.assuredworkloads.v1.IGetWorkloadRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
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
TypeDescription
Promise<{ [name: string]: Function; }>

{Promise} A promise that resolves to an authenticated service stub.

listWorkloads(request, options)

listWorkloads(request?: protos.google.cloud.assuredworkloads.v1.IListWorkloadsRequest, options?: CallOptions): Promise<[
        protos.google.cloud.assuredworkloads.v1.IWorkload[],
        protos.google.cloud.assuredworkloads.v1.IListWorkloadsRequest | null,
        protos.google.cloud.assuredworkloads.v1.IListWorkloadsResponse
    ]>;

Lists Assured Workloads under a CRM Node.

Parameters
NameDescription
request protos.google.cloud.assuredworkloads.v1.IListWorkloadsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.cloud.assuredworkloads.v1.IWorkload[], protos.google.cloud.assuredworkloads.v1.IListWorkloadsRequest | null, protos.google.cloud.assuredworkloads.v1.IListWorkloadsResponse ]>

{Promise} - The promise which resolves to an array. The first element of the array is Array of [Workload]. 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 listWorkloadsAsync() method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

listWorkloads(request, options, callback)

listWorkloads(request: protos.google.cloud.assuredworkloads.v1.IListWorkloadsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.assuredworkloads.v1.IListWorkloadsRequest, protos.google.cloud.assuredworkloads.v1.IListWorkloadsResponse | null | undefined, protos.google.cloud.assuredworkloads.v1.IWorkload>): void;
Parameters
NameDescription
request protos.google.cloud.assuredworkloads.v1.IListWorkloadsRequest
options CallOptions
callback PaginationCallback<protos.google.cloud.assuredworkloads.v1.IListWorkloadsRequest, protos.google.cloud.assuredworkloads.v1.IListWorkloadsResponse | null | undefined, protos.google.cloud.assuredworkloads.v1.IWorkload>
Returns
TypeDescription
void

listWorkloads(request, callback)

listWorkloads(request: protos.google.cloud.assuredworkloads.v1.IListWorkloadsRequest, callback: PaginationCallback<protos.google.cloud.assuredworkloads.v1.IListWorkloadsRequest, protos.google.cloud.assuredworkloads.v1.IListWorkloadsResponse | null | undefined, protos.google.cloud.assuredworkloads.v1.IWorkload>): void;
Parameters
NameDescription
request protos.google.cloud.assuredworkloads.v1.IListWorkloadsRequest
callback PaginationCallback<protos.google.cloud.assuredworkloads.v1.IListWorkloadsRequest, protos.google.cloud.assuredworkloads.v1.IListWorkloadsResponse | null | undefined, protos.google.cloud.assuredworkloads.v1.IWorkload>
Returns
TypeDescription
void

listWorkloadsAsync(request, options)

listWorkloadsAsync(request?: protos.google.cloud.assuredworkloads.v1.IListWorkloadsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.assuredworkloads.v1.IWorkload>;

Equivalent to listWorkloads, but returns an iterable object.

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

Parameters
NameDescription
request protos.google.cloud.assuredworkloads.v1.IListWorkloadsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
AsyncIterable<protos.google.cloud.assuredworkloads.v1.IWorkload>

{Object} An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). When you iterate the returned iterable, each element will be an object representing [Workload]. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

Example

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. Parent Resource to list workloads from.
   *  Must be of the form `organizations/{org_id}/locations/{location}`.
   */
  // const parent = 'abc123'
  /**
   *  Page size.
   */
  // const pageSize = 1234
  /**
   *  Page token returned from previous request. Page token contains context from
   *  previous request. Page token needs to be passed in the second and following
   *  requests.
   */
  // const pageToken = 'abc123'
  /**
   *  A custom filter for filtering by properties of a workload. At this time,
   *  only filtering by labels is supported.
   */
  // const filter = 'abc123'

  // Imports the Assuredworkloads library
  const {AssuredWorkloadsServiceClient} = require('@google-cloud/assured-workloads').v1;

  // Instantiates a client
  const assuredworkloadsClient = new AssuredWorkloadsServiceClient();

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

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

  callListWorkloads();

listWorkloadsStream(request, options)

listWorkloadsStream(request?: protos.google.cloud.assuredworkloads.v1.IListWorkloadsRequest, options?: CallOptions): Transform;

Equivalent to method.name.toCamelCase(), but returns a NodeJS Stream object.

Parameters
NameDescription
request protos.google.cloud.assuredworkloads.v1.IListWorkloadsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Transform

{Stream} An object stream which emits an object representing [Workload] 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 listWorkloadsAsync() method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

locationPath(organization, location)

locationPath(organization: string, location: string): string;

Return a fully-qualified location resource name string.

Parameters
NameDescription
organization string
location string
Returns
TypeDescription
string

{string} Resource name string.

matchLocationFromLocationName(locationName)

matchLocationFromLocationName(locationName: string): string | number;

Parse the location from Location resource.

Parameter
NameDescription
locationName string

A fully-qualified path representing Location resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchLocationFromWorkloadName(workloadName)

matchLocationFromWorkloadName(workloadName: string): string | number;

Parse the location from Workload resource.

Parameter
NameDescription
workloadName string

A fully-qualified path representing Workload resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchOrganizationFromLocationName(locationName)

matchOrganizationFromLocationName(locationName: string): string | number;

Parse the organization from Location resource.

Parameter
NameDescription
locationName string

A fully-qualified path representing Location resource.

Returns
TypeDescription
string | number

{string} A string representing the organization.

matchOrganizationFromOrganizationName(organizationName)

matchOrganizationFromOrganizationName(organizationName: string): string | number;

Parse the organization from Organization resource.

Parameter
NameDescription
organizationName string

A fully-qualified path representing Organization resource.

Returns
TypeDescription
string | number

{string} A string representing the organization.

matchOrganizationFromWorkloadName(workloadName)

matchOrganizationFromWorkloadName(workloadName: string): string | number;

Parse the organization from Workload resource.

Parameter
NameDescription
workloadName string

A fully-qualified path representing Workload resource.

Returns
TypeDescription
string | number

{string} A string representing the organization.

matchWorkloadFromWorkloadName(workloadName)

matchWorkloadFromWorkloadName(workloadName: string): string | number;

Parse the workload from Workload resource.

Parameter
NameDescription
workloadName string

A fully-qualified path representing Workload resource.

Returns
TypeDescription
string | number

{string} A string representing the workload.

organizationPath(organization)

organizationPath(organization: string): string;

Return a fully-qualified organization resource name string.

Parameter
NameDescription
organization string
Returns
TypeDescription
string

{string} Resource name string.

updateWorkload(request, options)

updateWorkload(request?: protos.google.cloud.assuredworkloads.v1.IUpdateWorkloadRequest, options?: CallOptions): Promise<[
        protos.google.cloud.assuredworkloads.v1.IWorkload,
        (protos.google.cloud.assuredworkloads.v1.IUpdateWorkloadRequest | undefined),
        {} | undefined
    ]>;

Updates an existing workload. Currently allows updating of workload display_name and labels. For force updates don't set etag field in the Workload. Only one update operation per workload can be in progress.

Parameters
NameDescription
request protos.google.cloud.assuredworkloads.v1.IUpdateWorkloadRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.cloud.assuredworkloads.v1.IWorkload, (protos.google.cloud.assuredworkloads.v1.IUpdateWorkloadRequest | undefined), {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing [Workload]. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples.

Example

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The workload to update.
   *  The workload’s `name` field is used to identify the workload to be updated.
   *  Format:
   *  organizations/{org_id}/locations/{location_id}/workloads/{workload_id}
   */
  // const workload = {}
  /**
   *  Required. The list of fields to be updated.
   */
  // const updateMask = {}

  // Imports the Assuredworkloads library
  const {AssuredWorkloadsServiceClient} = require('@google-cloud/assured-workloads').v1;

  // Instantiates a client
  const assuredworkloadsClient = new AssuredWorkloadsServiceClient();

  async function callUpdateWorkload() {
    // Construct request
    const request = {
      workload,
      updateMask,
    };

    // Run request
    const response = await assuredworkloadsClient.updateWorkload(request);
    console.log(response);
  }

  callUpdateWorkload();

updateWorkload(request, options, callback)

updateWorkload(request: protos.google.cloud.assuredworkloads.v1.IUpdateWorkloadRequest, options: CallOptions, callback: Callback<protos.google.cloud.assuredworkloads.v1.IWorkload, protos.google.cloud.assuredworkloads.v1.IUpdateWorkloadRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.assuredworkloads.v1.IUpdateWorkloadRequest
options CallOptions
callback Callback<protos.google.cloud.assuredworkloads.v1.IWorkload, protos.google.cloud.assuredworkloads.v1.IUpdateWorkloadRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

updateWorkload(request, callback)

updateWorkload(request: protos.google.cloud.assuredworkloads.v1.IUpdateWorkloadRequest, callback: Callback<protos.google.cloud.assuredworkloads.v1.IWorkload, protos.google.cloud.assuredworkloads.v1.IUpdateWorkloadRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.assuredworkloads.v1.IUpdateWorkloadRequest
callback Callback<protos.google.cloud.assuredworkloads.v1.IWorkload, protos.google.cloud.assuredworkloads.v1.IUpdateWorkloadRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

workloadPath(organization, location, workload)

workloadPath(organization: string, location: string, workload: string): string;

Return a fully-qualified workload resource name string.

Parameters
NameDescription
organization string
location string
workload string
Returns
TypeDescription
string

{string} Resource name string.