Class protos.google.cloud.workstations.v1.Workstations (1.1.1)

Represents a Workstations

Inheritance

$protobuf.rpc.Service > protos.google.cloud.workstations.v1.Workstations

Package

Constructors

(constructor)(rpcImpl, requestDelimited, responseDelimited)

constructor(rpcImpl: $protobuf.RPCImpl, requestDelimited?: boolean, responseDelimited?: boolean);

Constructs a new Workstations service.

Parameters
Name	Description
`rpcImpl`	`$protobuf.RPCImpl` RPC implementation
`requestDelimited`	`boolean` Whether requests are length-delimited
`responseDelimited`	`boolean` Whether responses are length-delimited

Methods

create(rpcImpl, requestDelimited, responseDelimited)

public static create(rpcImpl: $protobuf.RPCImpl, requestDelimited?: boolean, responseDelimited?: boolean): Workstations;

Creates new Workstations service using the specified rpc implementation.

Parameters
Name	Description
`rpcImpl`	`$protobuf.RPCImpl` RPC implementation
`requestDelimited`	`boolean` Whether requests are length-delimited
`responseDelimited`	`boolean` Whether responses are length-delimited

Returns
Type	Description
`Workstations`	RPC service. Useful where requests and/or responses are streamed.

createWorkstation(request, callback)

public createWorkstation(request: google.cloud.workstations.v1.ICreateWorkstationRequest, callback: google.cloud.workstations.v1.Workstations.CreateWorkstationCallback): void;

Calls CreateWorkstation.

Parameters
Name	Description
`request`	`ICreateWorkstationRequest` CreateWorkstationRequest message or plain object
`callback`	`CreateWorkstationCallback` Node-style callback called with the error, if any, and Operation

Returns
Type	Description
`void`

createWorkstation(request)

public createWorkstation(request: google.cloud.workstations.v1.ICreateWorkstationRequest): Promise<google.longrunning.Operation>;

Calls CreateWorkstation.

Parameter
Name	Description
`request`	`ICreateWorkstationRequest` CreateWorkstationRequest message or plain object

Returns
Type	Description
`Promise<google.longrunning.Operation>`	Promise

createWorkstationCluster(request, callback)

public createWorkstationCluster(request: google.cloud.workstations.v1.ICreateWorkstationClusterRequest, callback: google.cloud.workstations.v1.Workstations.CreateWorkstationClusterCallback): void;

Calls CreateWorkstationCluster.

Parameters
Name	Description
`request`	`ICreateWorkstationClusterRequest` CreateWorkstationClusterRequest message or plain object
`callback`	`CreateWorkstationClusterCallback` Node-style callback called with the error, if any, and Operation

Returns
Type	Description
`void`

createWorkstationCluster(request)

public createWorkstationCluster(request: google.cloud.workstations.v1.ICreateWorkstationClusterRequest): Promise<google.longrunning.Operation>;

Calls CreateWorkstationCluster.

Parameter
Name	Description
`request`	`ICreateWorkstationClusterRequest` CreateWorkstationClusterRequest message or plain object

Returns
Type	Description
`Promise<google.longrunning.Operation>`	Promise

createWorkstationConfig(request, callback)

public createWorkstationConfig(request: google.cloud.workstations.v1.ICreateWorkstationConfigRequest, callback: google.cloud.workstations.v1.Workstations.CreateWorkstationConfigCallback): void;

Calls CreateWorkstationConfig.

Parameters
Name	Description
`request`	`ICreateWorkstationConfigRequest` CreateWorkstationConfigRequest message or plain object
`callback`	`CreateWorkstationConfigCallback` Node-style callback called with the error, if any, and Operation

Returns
Type	Description
`void`

createWorkstationConfig(request)

public createWorkstationConfig(request: google.cloud.workstations.v1.ICreateWorkstationConfigRequest): Promise<google.longrunning.Operation>;

Calls CreateWorkstationConfig.

Parameter
Name	Description
`request`	`ICreateWorkstationConfigRequest` CreateWorkstationConfigRequest message or plain object

Returns
Type	Description
`Promise<google.longrunning.Operation>`	Promise

deleteWorkstation(request, callback)

public deleteWorkstation(request: google.cloud.workstations.v1.IDeleteWorkstationRequest, callback: google.cloud.workstations.v1.Workstations.DeleteWorkstationCallback): void;

Calls DeleteWorkstation.

Parameters
Name	Description
`request`	`IDeleteWorkstationRequest` DeleteWorkstationRequest message or plain object
`callback`	`DeleteWorkstationCallback` Node-style callback called with the error, if any, and Operation

Returns
Type	Description
`void`

deleteWorkstation(request)

public deleteWorkstation(request: google.cloud.workstations.v1.IDeleteWorkstationRequest): Promise<google.longrunning.Operation>;

Calls DeleteWorkstation.

Parameter
Name	Description
`request`	`IDeleteWorkstationRequest` DeleteWorkstationRequest message or plain object

Returns
Type	Description
`Promise<google.longrunning.Operation>`	Promise

deleteWorkstationCluster(request, callback)

public deleteWorkstationCluster(request: google.cloud.workstations.v1.IDeleteWorkstationClusterRequest, callback: google.cloud.workstations.v1.Workstations.DeleteWorkstationClusterCallback): void;

Calls DeleteWorkstationCluster.

Parameters
Name	Description
`request`	`IDeleteWorkstationClusterRequest` DeleteWorkstationClusterRequest message or plain object
`callback`	`DeleteWorkstationClusterCallback` Node-style callback called with the error, if any, and Operation

Returns
Type	Description
`void`

deleteWorkstationCluster(request)

public deleteWorkstationCluster(request: google.cloud.workstations.v1.IDeleteWorkstationClusterRequest): Promise<google.longrunning.Operation>;

Calls DeleteWorkstationCluster.

Parameter
Name	Description
`request`	`IDeleteWorkstationClusterRequest` DeleteWorkstationClusterRequest message or plain object

Returns
Type	Description
`Promise<google.longrunning.Operation>`	Promise

deleteWorkstationConfig(request, callback)

public deleteWorkstationConfig(request: google.cloud.workstations.v1.IDeleteWorkstationConfigRequest, callback: google.cloud.workstations.v1.Workstations.DeleteWorkstationConfigCallback): void;

Calls DeleteWorkstationConfig.

Parameters
Name	Description
`request`	`IDeleteWorkstationConfigRequest` DeleteWorkstationConfigRequest message or plain object
`callback`	`DeleteWorkstationConfigCallback` Node-style callback called with the error, if any, and Operation

Returns
Type	Description
`void`

deleteWorkstationConfig(request)

public deleteWorkstationConfig(request: google.cloud.workstations.v1.IDeleteWorkstationConfigRequest): Promise<google.longrunning.Operation>;

Calls DeleteWorkstationConfig.

Parameter
Name	Description
`request`	`IDeleteWorkstationConfigRequest` DeleteWorkstationConfigRequest message or plain object

Returns
Type	Description
`Promise<google.longrunning.Operation>`	Promise

generateAccessToken(request, callback)

public generateAccessToken(request: google.cloud.workstations.v1.IGenerateAccessTokenRequest, callback: google.cloud.workstations.v1.Workstations.GenerateAccessTokenCallback): void;

Calls GenerateAccessToken.

Parameters
Name	Description
`request`	`IGenerateAccessTokenRequest` GenerateAccessTokenRequest message or plain object
`callback`	`GenerateAccessTokenCallback` Node-style callback called with the error, if any, and GenerateAccessTokenResponse

Returns
Type	Description
`void`

generateAccessToken(request)

public generateAccessToken(request: google.cloud.workstations.v1.IGenerateAccessTokenRequest): Promise<google.cloud.workstations.v1.GenerateAccessTokenResponse>;

Calls GenerateAccessToken.

Parameter
Name	Description
`request`	`IGenerateAccessTokenRequest` GenerateAccessTokenRequest message or plain object

Returns
Type	Description
`Promise<google.cloud.workstations.v1.GenerateAccessTokenResponse>`	Promise

getWorkstation(request, callback)

public getWorkstation(request: google.cloud.workstations.v1.IGetWorkstationRequest, callback: google.cloud.workstations.v1.Workstations.GetWorkstationCallback): void;

Calls GetWorkstation.

Parameters
Name	Description
`request`	`IGetWorkstationRequest` GetWorkstationRequest message or plain object
`callback`	`GetWorkstationCallback` Node-style callback called with the error, if any, and Workstation

Returns
Type	Description
`void`

getWorkstation(request)

public getWorkstation(request: google.cloud.workstations.v1.IGetWorkstationRequest): Promise<google.cloud.workstations.v1.Workstation>;

Calls GetWorkstation.

Parameter
Name	Description
`request`	`IGetWorkstationRequest` GetWorkstationRequest message or plain object

Returns
Type	Description
`Promise<google.cloud.workstations.v1.Workstation>`	Promise

getWorkstationCluster(request, callback)

public getWorkstationCluster(request: google.cloud.workstations.v1.IGetWorkstationClusterRequest, callback: google.cloud.workstations.v1.Workstations.GetWorkstationClusterCallback): void;

Calls GetWorkstationCluster.

Parameters
Name	Description
`request`	`IGetWorkstationClusterRequest` GetWorkstationClusterRequest message or plain object
`callback`	`GetWorkstationClusterCallback` Node-style callback called with the error, if any, and WorkstationCluster

Returns
Type	Description
`void`

getWorkstationCluster(request)

public getWorkstationCluster(request: google.cloud.workstations.v1.IGetWorkstationClusterRequest): Promise<google.cloud.workstations.v1.WorkstationCluster>;

Calls GetWorkstationCluster.

Parameter
Name	Description
`request`	`IGetWorkstationClusterRequest` GetWorkstationClusterRequest message or plain object

Returns
Type	Description
`Promise<google.cloud.workstations.v1.WorkstationCluster>`	Promise

getWorkstationConfig(request, callback)

public getWorkstationConfig(request: google.cloud.workstations.v1.IGetWorkstationConfigRequest, callback: google.cloud.workstations.v1.Workstations.GetWorkstationConfigCallback): void;

Calls GetWorkstationConfig.

Parameters
Name	Description
`request`	`IGetWorkstationConfigRequest` GetWorkstationConfigRequest message or plain object
`callback`	`GetWorkstationConfigCallback` Node-style callback called with the error, if any, and WorkstationConfig

Returns
Type	Description
`void`

getWorkstationConfig(request)

public getWorkstationConfig(request: google.cloud.workstations.v1.IGetWorkstationConfigRequest): Promise<google.cloud.workstations.v1.WorkstationConfig>;

Calls GetWorkstationConfig.

Parameter
Name	Description
`request`	`IGetWorkstationConfigRequest` GetWorkstationConfigRequest message or plain object

Returns
Type	Description
`Promise<google.cloud.workstations.v1.WorkstationConfig>`	Promise

listUsableWorkstationConfigs(request, callback)

public listUsableWorkstationConfigs(request: google.cloud.workstations.v1.IListUsableWorkstationConfigsRequest, callback: google.cloud.workstations.v1.Workstations.ListUsableWorkstationConfigsCallback): void;

Calls ListUsableWorkstationConfigs.

Parameters
Name	Description
`request`	`IListUsableWorkstationConfigsRequest` ListUsableWorkstationConfigsRequest message or plain object
`callback`	`ListUsableWorkstationConfigsCallback` Node-style callback called with the error, if any, and ListUsableWorkstationConfigsResponse

Returns
Type	Description
`void`

listUsableWorkstationConfigs(request)

public listUsableWorkstationConfigs(request: google.cloud.workstations.v1.IListUsableWorkstationConfigsRequest): Promise<google.cloud.workstations.v1.ListUsableWorkstationConfigsResponse>;

Calls ListUsableWorkstationConfigs.

Parameter
Name	Description
`request`	`IListUsableWorkstationConfigsRequest` ListUsableWorkstationConfigsRequest message or plain object

Returns
Type	Description
`Promise<google.cloud.workstations.v1.ListUsableWorkstationConfigsResponse>`	Promise

listUsableWorkstations(request, callback)

public listUsableWorkstations(request: google.cloud.workstations.v1.IListUsableWorkstationsRequest, callback: google.cloud.workstations.v1.Workstations.ListUsableWorkstationsCallback): void;

Calls ListUsableWorkstations.

Parameters
Name	Description
`request`	`IListUsableWorkstationsRequest` ListUsableWorkstationsRequest message or plain object
`callback`	`ListUsableWorkstationsCallback` Node-style callback called with the error, if any, and ListUsableWorkstationsResponse

Returns
Type	Description
`void`

listUsableWorkstations(request)

public listUsableWorkstations(request: google.cloud.workstations.v1.IListUsableWorkstationsRequest): Promise<google.cloud.workstations.v1.ListUsableWorkstationsResponse>;

Calls ListUsableWorkstations.

Parameter
Name	Description
`request`	`IListUsableWorkstationsRequest` ListUsableWorkstationsRequest message or plain object

Returns
Type	Description
`Promise<google.cloud.workstations.v1.ListUsableWorkstationsResponse>`	Promise

listWorkstationClusters(request, callback)

public listWorkstationClusters(request: google.cloud.workstations.v1.IListWorkstationClustersRequest, callback: google.cloud.workstations.v1.Workstations.ListWorkstationClustersCallback): void;

Calls ListWorkstationClusters.

Parameters
Name	Description
`request`	`IListWorkstationClustersRequest` ListWorkstationClustersRequest message or plain object
`callback`	`ListWorkstationClustersCallback` Node-style callback called with the error, if any, and ListWorkstationClustersResponse

Returns
Type	Description
`void`

listWorkstationClusters(request)

public listWorkstationClusters(request: google.cloud.workstations.v1.IListWorkstationClustersRequest): Promise<google.cloud.workstations.v1.ListWorkstationClustersResponse>;

Calls ListWorkstationClusters.

Parameter
Name	Description
`request`	`IListWorkstationClustersRequest` ListWorkstationClustersRequest message or plain object

Returns
Type	Description
`Promise<google.cloud.workstations.v1.ListWorkstationClustersResponse>`	Promise

listWorkstationConfigs(request, callback)

public listWorkstationConfigs(request: google.cloud.workstations.v1.IListWorkstationConfigsRequest, callback: google.cloud.workstations.v1.Workstations.ListWorkstationConfigsCallback): void;

Calls ListWorkstationConfigs.

Parameters
Name	Description
`request`	`IListWorkstationConfigsRequest` ListWorkstationConfigsRequest message or plain object
`callback`	`ListWorkstationConfigsCallback` Node-style callback called with the error, if any, and ListWorkstationConfigsResponse

Returns
Type	Description
`void`

listWorkstationConfigs(request)

public listWorkstationConfigs(request: google.cloud.workstations.v1.IListWorkstationConfigsRequest): Promise<google.cloud.workstations.v1.ListWorkstationConfigsResponse>;

Calls ListWorkstationConfigs.

Parameter
Name	Description
`request`	`IListWorkstationConfigsRequest` ListWorkstationConfigsRequest message or plain object

Returns
Type	Description
`Promise<google.cloud.workstations.v1.ListWorkstationConfigsResponse>`	Promise

listWorkstations(request, callback)

public listWorkstations(request: google.cloud.workstations.v1.IListWorkstationsRequest, callback: google.cloud.workstations.v1.Workstations.ListWorkstationsCallback): void;

Calls ListWorkstations.

Parameters
Name	Description
`request`	`IListWorkstationsRequest` ListWorkstationsRequest message or plain object
`callback`	`ListWorkstationsCallback` Node-style callback called with the error, if any, and ListWorkstationsResponse

Returns
Type	Description
`void`

listWorkstations(request)

public listWorkstations(request: google.cloud.workstations.v1.IListWorkstationsRequest): Promise<google.cloud.workstations.v1.ListWorkstationsResponse>;

Calls ListWorkstations.

Parameter
Name	Description
`request`	`IListWorkstationsRequest` ListWorkstationsRequest message or plain object

Returns
Type	Description
`Promise<google.cloud.workstations.v1.ListWorkstationsResponse>`	Promise

startWorkstation(request, callback)

public startWorkstation(request: google.cloud.workstations.v1.IStartWorkstationRequest, callback: google.cloud.workstations.v1.Workstations.StartWorkstationCallback): void;

Calls StartWorkstation.

Parameters
Name	Description
`request`	`IStartWorkstationRequest` StartWorkstationRequest message or plain object
`callback`	`StartWorkstationCallback` Node-style callback called with the error, if any, and Operation

Returns
Type	Description
`void`

startWorkstation(request)

public startWorkstation(request: google.cloud.workstations.v1.IStartWorkstationRequest): Promise<google.longrunning.Operation>;

Calls StartWorkstation.

Parameter
Name	Description
`request`	`IStartWorkstationRequest` StartWorkstationRequest message or plain object

Returns
Type	Description
`Promise<google.longrunning.Operation>`	Promise

stopWorkstation(request, callback)

public stopWorkstation(request: google.cloud.workstations.v1.IStopWorkstationRequest, callback: google.cloud.workstations.v1.Workstations.StopWorkstationCallback): void;

Calls StopWorkstation.

Parameters
Name	Description
`request`	`IStopWorkstationRequest` StopWorkstationRequest message or plain object
`callback`	`StopWorkstationCallback` Node-style callback called with the error, if any, and Operation

Returns
Type	Description
`void`

stopWorkstation(request)

public stopWorkstation(request: google.cloud.workstations.v1.IStopWorkstationRequest): Promise<google.longrunning.Operation>;

Calls StopWorkstation.

Parameter
Name	Description
`request`	`IStopWorkstationRequest` StopWorkstationRequest message or plain object

Returns
Type	Description
`Promise<google.longrunning.Operation>`	Promise

updateWorkstation(request, callback)

public updateWorkstation(request: google.cloud.workstations.v1.IUpdateWorkstationRequest, callback: google.cloud.workstations.v1.Workstations.UpdateWorkstationCallback): void;

Calls UpdateWorkstation.

Parameters
Name	Description
`request`	`IUpdateWorkstationRequest` UpdateWorkstationRequest message or plain object
`callback`	`UpdateWorkstationCallback` Node-style callback called with the error, if any, and Operation

Returns
Type	Description
`void`

updateWorkstation(request)

public updateWorkstation(request: google.cloud.workstations.v1.IUpdateWorkstationRequest): Promise<google.longrunning.Operation>;

Calls UpdateWorkstation.

Parameter
Name	Description
`request`	`IUpdateWorkstationRequest` UpdateWorkstationRequest message or plain object

Returns
Type	Description
`Promise<google.longrunning.Operation>`	Promise

updateWorkstationCluster(request, callback)

public updateWorkstationCluster(request: google.cloud.workstations.v1.IUpdateWorkstationClusterRequest, callback: google.cloud.workstations.v1.Workstations.UpdateWorkstationClusterCallback): void;

Calls UpdateWorkstationCluster.

Parameters
Name	Description
`request`	`IUpdateWorkstationClusterRequest` UpdateWorkstationClusterRequest message or plain object
`callback`	`UpdateWorkstationClusterCallback` Node-style callback called with the error, if any, and Operation

Returns
Type	Description
`void`

updateWorkstationCluster(request)

public updateWorkstationCluster(request: google.cloud.workstations.v1.IUpdateWorkstationClusterRequest): Promise<google.longrunning.Operation>;

Calls UpdateWorkstationCluster.

Parameter
Name	Description
`request`	`IUpdateWorkstationClusterRequest` UpdateWorkstationClusterRequest message or plain object

Returns
Type	Description
`Promise<google.longrunning.Operation>`	Promise

updateWorkstationConfig(request, callback)

public updateWorkstationConfig(request: google.cloud.workstations.v1.IUpdateWorkstationConfigRequest, callback: google.cloud.workstations.v1.Workstations.UpdateWorkstationConfigCallback): void;

Calls UpdateWorkstationConfig.

Parameters
Name	Description
`request`	`IUpdateWorkstationConfigRequest` UpdateWorkstationConfigRequest message or plain object
`callback`	`UpdateWorkstationConfigCallback` Node-style callback called with the error, if any, and Operation

Returns
Type	Description
`void`

updateWorkstationConfig(request)

public updateWorkstationConfig(request: google.cloud.workstations.v1.IUpdateWorkstationConfigRequest): Promise<google.longrunning.Operation>;

Calls UpdateWorkstationConfig.

Parameter
Name	Description
`request`	`IUpdateWorkstationConfigRequest` UpdateWorkstationConfigRequest message or plain object

Returns
Type	Description
`Promise<google.longrunning.Operation>`	Promise