Class v1beta1.AssuredWorkloadsServiceClient (1.5.2)

Service to manage AssuredWorkloads. v1beta1

Package

@google-cloud/assured-workloads!

Constructors

(constructor)(opts)

constructor(opts?: ClientOptions);

Construct an instance of AssuredWorkloadsServiceClient.

Parameter

Name	Description
opts	`ClientOptions`

Properties

apiEndpoint

static get apiEndpoint(): string;

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

Property Value

Type	Description
string

assuredWorkloadsServiceStub

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

Property Value

Type	Description
Promise<{ [name: string]: Function; }>

auth

auth: gax.GoogleAuth;

Property Value

Type	Description
gax.GoogleAuth

descriptors

descriptors: Descriptors;

Property Value

Type	Description
Descriptors

innerApiCalls

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

Property Value

Type	Description
{ [name: string]: Function; }

operationsClient

operationsClient: gax.OperationsClient;

Property Value

Type	Description
gax.OperationsClient

pathTemplates

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

Property Value

Type	Description
{ [name: string]: gax.PathTemplate; }

port

static get port(): number;

The port for this API service.

Property Value

Type	Description
number

scopes

static get scopes(): string[];

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

Property Value

Type	Description
string[]

servicePath

static get servicePath(): string;

The DNS address for this API service.

Property Value

Type	Description
string

warn

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

Property Value

Type	Description
(code: string, message: string, warnType?: string) => void

Methods

checkCreateWorkloadProgress(name)

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

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

Parameter

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

Returns

Type	Description
Promise<LROperation<protos.google.cloud.assuredworkloads.v1beta1.Workload, protos.google.cloud.assuredworkloads.v1beta1.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.

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.

createWorkload(request, options)

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

Parameters

Name	Description
request	`protos.google.cloud.assuredworkloads.v1beta1.ICreateWorkloadRequest`
options	`CallOptions`

Returns

Type	Description
Promise<[LROperation<protos.google.cloud.assuredworkloads.v1beta1.IWorkload, protos.google.cloud.assuredworkloads.v1beta1.ICreateWorkloadOperationMetadata>, protos.google.longrunning.IOperation \| undefined, {} \| undefined]>

createWorkload(request, options, callback)

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

Parameters

Name	Description
request	`protos.google.cloud.assuredworkloads.v1beta1.ICreateWorkloadRequest`
options	`CallOptions`
callback	`Callback<LROperation<protos.google.cloud.assuredworkloads.v1beta1.IWorkload, protos.google.cloud.assuredworkloads.v1beta1.ICreateWorkloadOperationMetadata>, protos.google.longrunning.IOperation \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

createWorkload(request, callback)

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

Parameters

Name	Description
request	`protos.google.cloud.assuredworkloads.v1beta1.ICreateWorkloadRequest`
callback	`Callback<LROperation<protos.google.cloud.assuredworkloads.v1beta1.IWorkload, protos.google.cloud.assuredworkloads.v1beta1.ICreateWorkloadOperationMetadata>, protos.google.longrunning.IOperation \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

deleteWorkload(request, options)

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

Parameters

Name	Description
request	`protos.google.cloud.assuredworkloads.v1beta1.IDeleteWorkloadRequest`
options	`CallOptions`

Returns

Type	Description
Promise<[protos.google.protobuf.IEmpty, (protos.google.cloud.assuredworkloads.v1beta1.IDeleteWorkloadRequest \| undefined), {} \| undefined]>

deleteWorkload(request, options, callback)

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

Parameters

Name	Description
request	`protos.google.cloud.assuredworkloads.v1beta1.IDeleteWorkloadRequest`
options	`CallOptions`
callback	`Callback<protos.google.protobuf.IEmpty, protos.google.cloud.assuredworkloads.v1beta1.IDeleteWorkloadRequest \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

deleteWorkload(request, callback)

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

Parameters

Name	Description
request	`protos.google.cloud.assuredworkloads.v1beta1.IDeleteWorkloadRequest`
callback	`Callback<protos.google.protobuf.IEmpty, protos.google.cloud.assuredworkloads.v1beta1.IDeleteWorkloadRequest \| 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

getWorkload(request, options)

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

Parameters

Name	Description
request	`protos.google.cloud.assuredworkloads.v1beta1.IGetWorkloadRequest`
options	`CallOptions`

Returns

Type	Description
Promise<[protos.google.cloud.assuredworkloads.v1beta1.IWorkload, (protos.google.cloud.assuredworkloads.v1beta1.IGetWorkloadRequest \| undefined), {} \| undefined]>

getWorkload(request, options, callback)

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

Parameters

Name	Description
request	`protos.google.cloud.assuredworkloads.v1beta1.IGetWorkloadRequest`
options	`CallOptions`
callback	`Callback<protos.google.cloud.assuredworkloads.v1beta1.IWorkload, protos.google.cloud.assuredworkloads.v1beta1.IGetWorkloadRequest \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

getWorkload(request, callback)

getWorkload(request: protos.google.cloud.assuredworkloads.v1beta1.IGetWorkloadRequest, callback: Callback<protos.google.cloud.assuredworkloads.v1beta1.IWorkload, protos.google.cloud.assuredworkloads.v1beta1.IGetWorkloadRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.cloud.assuredworkloads.v1beta1.IGetWorkloadRequest`
callback	`Callback<protos.google.cloud.assuredworkloads.v1beta1.IWorkload, protos.google.cloud.assuredworkloads.v1beta1.IGetWorkloadRequest \| null \| undefined, {} \| null \| 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.

listWorkloads(request, options)

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

Parameters

Name	Description
request	`protos.google.cloud.assuredworkloads.v1beta1.IListWorkloadsRequest`
options	`CallOptions`

Returns

Type	Description
Promise<[protos.google.cloud.assuredworkloads.v1beta1.IWorkload[], protos.google.cloud.assuredworkloads.v1beta1.IListWorkloadsRequest \| null, protos.google.cloud.assuredworkloads.v1beta1.IListWorkloadsResponse]>

listWorkloads(request, options, callback)

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

Parameters

Name	Description
request	`protos.google.cloud.assuredworkloads.v1beta1.IListWorkloadsRequest`
options	`CallOptions`
callback	`PaginationCallback<protos.google.cloud.assuredworkloads.v1beta1.IListWorkloadsRequest, protos.google.cloud.assuredworkloads.v1beta1.IListWorkloadsResponse \| null \| undefined, protos.google.cloud.assuredworkloads.v1beta1.IWorkload>`

Returns

Type	Description
void

listWorkloads(request, callback)

listWorkloads(request: protos.google.cloud.assuredworkloads.v1beta1.IListWorkloadsRequest, callback: PaginationCallback<protos.google.cloud.assuredworkloads.v1beta1.IListWorkloadsRequest, protos.google.cloud.assuredworkloads.v1beta1.IListWorkloadsResponse | null | undefined, protos.google.cloud.assuredworkloads.v1beta1.IWorkload>): void;

Parameters

Name	Description
request	`protos.google.cloud.assuredworkloads.v1beta1.IListWorkloadsRequest`
callback	`PaginationCallback<protos.google.cloud.assuredworkloads.v1beta1.IListWorkloadsRequest, protos.google.cloud.assuredworkloads.v1beta1.IListWorkloadsResponse \| null \| undefined, protos.google.cloud.assuredworkloads.v1beta1.IWorkload>`

Returns

Type	Description
void

listWorkloadsAsync(request, options)

listWorkloadsAsync(request?: protos.google.cloud.assuredworkloads.v1beta1.IListWorkloadsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.assuredworkloads.v1beta1.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

Name	Description
request	`protos.google.cloud.assuredworkloads.v1beta1.IListWorkloadsRequest` The request object that will be sent.
options	`CallOptions` Call options. See CallOptions for more details.

Returns

Type

Description

AsyncIterable<protos.google.cloud.assuredworkloads.v1beta1.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.

listWorkloadsStream(request, options)

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

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

Parameters

Name	Description
request	`protos.google.cloud.assuredworkloads.v1beta1.IListWorkloadsRequest` 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 [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

Name	Description
organization	`string`
location	`string`

Returns

Type	Description
string	{string} Resource name string.

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.

matchLocationFromWorkloadName(workloadName)

matchLocationFromWorkloadName(workloadName: string): string | number;

Parse the location from Workload resource.

Parameter

Name	Description
workloadName	`string` A fully-qualified path representing Workload resource.

Returns

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

matchOrganizationFromLocationName(locationName)

matchOrganizationFromLocationName(locationName: string): string | number;

Parse the organization 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 organization.

matchOrganizationFromOrganizationName(organizationName)

matchOrganizationFromOrganizationName(organizationName: string): string | number;

Parse the organization from Organization resource.

Parameter

Name	Description
organizationName	`string` A fully-qualified path representing Organization resource.

Returns

Type	Description
string \| number	{string} A string representing the organization.

matchOrganizationFromWorkloadName(workloadName)

matchOrganizationFromWorkloadName(workloadName: string): string | number;

Parse the organization from Workload resource.

Parameter

Name	Description
workloadName	`string` A fully-qualified path representing Workload resource.

Returns

Type	Description
string \| number	{string} A string representing the organization.

matchWorkloadFromWorkloadName(workloadName)

matchWorkloadFromWorkloadName(workloadName: string): string | number;

Parse the workload from Workload resource.

Parameter

Name	Description
workloadName	`string` A fully-qualified path representing Workload resource.

Returns

Type	Description
string \| number	{string} A string representing the workload.

organizationPath(organization)

organizationPath(organization: string): string;

Return a fully-qualified organization resource name string.

Parameter

Name	Description
organization	`string`

Returns

Type	Description
string	{string} Resource name string.

updateWorkload(request, options)

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

Parameters

Name	Description
request	`protos.google.cloud.assuredworkloads.v1beta1.IUpdateWorkloadRequest`
options	`CallOptions`

Returns

Type	Description
Promise<[protos.google.cloud.assuredworkloads.v1beta1.IWorkload, (protos.google.cloud.assuredworkloads.v1beta1.IUpdateWorkloadRequest \| undefined), {} \| undefined]>

updateWorkload(request, options, callback)

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

Parameters

Name	Description
request	`protos.google.cloud.assuredworkloads.v1beta1.IUpdateWorkloadRequest`
options	`CallOptions`
callback	`Callback<protos.google.cloud.assuredworkloads.v1beta1.IWorkload, protos.google.cloud.assuredworkloads.v1beta1.IUpdateWorkloadRequest \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

updateWorkload(request, callback)

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

Parameters

Name	Description
request	`protos.google.cloud.assuredworkloads.v1beta1.IUpdateWorkloadRequest`
callback	`Callback<protos.google.cloud.assuredworkloads.v1beta1.IWorkload, protos.google.cloud.assuredworkloads.v1beta1.IUpdateWorkloadRequest \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

workloadPath(organization, location, workload)

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

Return a fully-qualified workload resource name string.

Parameters

Name	Description
organization	`string`
location	`string`
workload	`string`

Returns

Type	Description
string	{string} Resource name string.