Represents a Workstations
Inheritance
$protobuf.rpc.Service > protos.google.cloud.workstations.v1beta.WorkstationsPackage
@google-cloud/workstationsConstructors
(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.v1beta.ICreateWorkstationRequest, callback: google.cloud.workstations.v1beta.Workstations.CreateWorkstationCallback): void;
Calls CreateWorkstation.
Parameters | |
---|---|
Name | Description |
request |
ICreateWorkstationRequest
CreateWorkstationRequest message or plain object |
callback |
google.cloud.workstations.v1beta.Workstations.CreateWorkstationCallback
Node-style callback called with the error, if any, and Operation |
Returns | |
---|---|
Type | Description |
void |
createWorkstation(request)
public createWorkstation(request: google.cloud.workstations.v1beta.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.v1beta.ICreateWorkstationClusterRequest, callback: google.cloud.workstations.v1beta.Workstations.CreateWorkstationClusterCallback): void;
Calls CreateWorkstationCluster.
Parameters | |
---|---|
Name | Description |
request |
google.cloud.workstations.v1beta.ICreateWorkstationClusterRequest
CreateWorkstationClusterRequest message or plain object |
callback |
google.cloud.workstations.v1beta.Workstations.CreateWorkstationClusterCallback
Node-style callback called with the error, if any, and Operation |
Returns | |
---|---|
Type | Description |
void |
createWorkstationCluster(request)
public createWorkstationCluster(request: google.cloud.workstations.v1beta.ICreateWorkstationClusterRequest): Promise<google.longrunning.Operation>;
Calls CreateWorkstationCluster.
Parameter | |
---|---|
Name | Description |
request |
google.cloud.workstations.v1beta.ICreateWorkstationClusterRequest
CreateWorkstationClusterRequest message or plain object |
Returns | |
---|---|
Type | Description |
Promise<google.longrunning.Operation> | Promise |
createWorkstationConfig(request, callback)
public createWorkstationConfig(request: google.cloud.workstations.v1beta.ICreateWorkstationConfigRequest, callback: google.cloud.workstations.v1beta.Workstations.CreateWorkstationConfigCallback): void;
Calls CreateWorkstationConfig.
Parameters | |
---|---|
Name | Description |
request |
google.cloud.workstations.v1beta.ICreateWorkstationConfigRequest
CreateWorkstationConfigRequest message or plain object |
callback |
google.cloud.workstations.v1beta.Workstations.CreateWorkstationConfigCallback
Node-style callback called with the error, if any, and Operation |
Returns | |
---|---|
Type | Description |
void |
createWorkstationConfig(request)
public createWorkstationConfig(request: google.cloud.workstations.v1beta.ICreateWorkstationConfigRequest): Promise<google.longrunning.Operation>;
Calls CreateWorkstationConfig.
Parameter | |
---|---|
Name | Description |
request |
google.cloud.workstations.v1beta.ICreateWorkstationConfigRequest
CreateWorkstationConfigRequest message or plain object |
Returns | |
---|---|
Type | Description |
Promise<google.longrunning.Operation> | Promise |
deleteWorkstation(request, callback)
public deleteWorkstation(request: google.cloud.workstations.v1beta.IDeleteWorkstationRequest, callback: google.cloud.workstations.v1beta.Workstations.DeleteWorkstationCallback): void;
Calls DeleteWorkstation.
Parameters | |
---|---|
Name | Description |
request |
google.cloud.workstations.v1beta.IDeleteWorkstationRequest
DeleteWorkstationRequest message or plain object |
callback |
google.cloud.workstations.v1beta.Workstations.DeleteWorkstationCallback
Node-style callback called with the error, if any, and Operation |
Returns | |
---|---|
Type | Description |
void |
deleteWorkstation(request)
public deleteWorkstation(request: google.cloud.workstations.v1beta.IDeleteWorkstationRequest): Promise<google.longrunning.Operation>;
Calls DeleteWorkstation.
Parameter | |
---|---|
Name | Description |
request |
google.cloud.workstations.v1beta.IDeleteWorkstationRequest
DeleteWorkstationRequest message or plain object |
Returns | |
---|---|
Type | Description |
Promise<google.longrunning.Operation> | Promise |
deleteWorkstationCluster(request, callback)
public deleteWorkstationCluster(request: google.cloud.workstations.v1beta.IDeleteWorkstationClusterRequest, callback: google.cloud.workstations.v1beta.Workstations.DeleteWorkstationClusterCallback): void;
Calls DeleteWorkstationCluster.
Parameters | |
---|---|
Name | Description |
request |
google.cloud.workstations.v1beta.IDeleteWorkstationClusterRequest
DeleteWorkstationClusterRequest message or plain object |
callback |
google.cloud.workstations.v1beta.Workstations.DeleteWorkstationClusterCallback
Node-style callback called with the error, if any, and Operation |
Returns | |
---|---|
Type | Description |
void |
deleteWorkstationCluster(request)
public deleteWorkstationCluster(request: google.cloud.workstations.v1beta.IDeleteWorkstationClusterRequest): Promise<google.longrunning.Operation>;
Calls DeleteWorkstationCluster.
Parameter | |
---|---|
Name | Description |
request |
google.cloud.workstations.v1beta.IDeleteWorkstationClusterRequest
DeleteWorkstationClusterRequest message or plain object |
Returns | |
---|---|
Type | Description |
Promise<google.longrunning.Operation> | Promise |
deleteWorkstationConfig(request, callback)
public deleteWorkstationConfig(request: google.cloud.workstations.v1beta.IDeleteWorkstationConfigRequest, callback: google.cloud.workstations.v1beta.Workstations.DeleteWorkstationConfigCallback): void;
Calls DeleteWorkstationConfig.
Parameters | |
---|---|
Name | Description |
request |
google.cloud.workstations.v1beta.IDeleteWorkstationConfigRequest
DeleteWorkstationConfigRequest message or plain object |
callback |
google.cloud.workstations.v1beta.Workstations.DeleteWorkstationConfigCallback
Node-style callback called with the error, if any, and Operation |
Returns | |
---|---|
Type | Description |
void |
deleteWorkstationConfig(request)
public deleteWorkstationConfig(request: google.cloud.workstations.v1beta.IDeleteWorkstationConfigRequest): Promise<google.longrunning.Operation>;
Calls DeleteWorkstationConfig.
Parameter | |
---|---|
Name | Description |
request |
google.cloud.workstations.v1beta.IDeleteWorkstationConfigRequest
DeleteWorkstationConfigRequest message or plain object |
Returns | |
---|---|
Type | Description |
Promise<google.longrunning.Operation> | Promise |
generateAccessToken(request, callback)
public generateAccessToken(request: google.cloud.workstations.v1beta.IGenerateAccessTokenRequest, callback: google.cloud.workstations.v1beta.Workstations.GenerateAccessTokenCallback): void;
Calls GenerateAccessToken.
Parameters | |
---|---|
Name | Description |
request |
google.cloud.workstations.v1beta.IGenerateAccessTokenRequest
GenerateAccessTokenRequest message or plain object |
callback |
google.cloud.workstations.v1beta.Workstations.GenerateAccessTokenCallback
Node-style callback called with the error, if any, and GenerateAccessTokenResponse |
Returns | |
---|---|
Type | Description |
void |
generateAccessToken(request)
public generateAccessToken(request: google.cloud.workstations.v1beta.IGenerateAccessTokenRequest): Promise<google.cloud.workstations.v1beta.GenerateAccessTokenResponse>;
Calls GenerateAccessToken.
Parameter | |
---|---|
Name | Description |
request |
google.cloud.workstations.v1beta.IGenerateAccessTokenRequest
GenerateAccessTokenRequest message or plain object |
Returns | |
---|---|
Type | Description |
Promise<google.cloud.workstations.v1beta.GenerateAccessTokenResponse> | Promise |
getWorkstation(request, callback)
public getWorkstation(request: google.cloud.workstations.v1beta.IGetWorkstationRequest, callback: google.cloud.workstations.v1beta.Workstations.GetWorkstationCallback): void;
Calls GetWorkstation.
Parameters | |
---|---|
Name | Description |
request |
google.cloud.workstations.v1beta.IGetWorkstationRequest
GetWorkstationRequest message or plain object |
callback |
google.cloud.workstations.v1beta.Workstations.GetWorkstationCallback
Node-style callback called with the error, if any, and Workstation |
Returns | |
---|---|
Type | Description |
void |
getWorkstation(request)
public getWorkstation(request: google.cloud.workstations.v1beta.IGetWorkstationRequest): Promise<google.cloud.workstations.v1beta.Workstation>;
Calls GetWorkstation.
Parameter | |
---|---|
Name | Description |
request |
google.cloud.workstations.v1beta.IGetWorkstationRequest
GetWorkstationRequest message or plain object |
Returns | |
---|---|
Type | Description |
Promise<google.cloud.workstations.v1beta.Workstation> | Promise |
getWorkstationCluster(request, callback)
public getWorkstationCluster(request: google.cloud.workstations.v1beta.IGetWorkstationClusterRequest, callback: google.cloud.workstations.v1beta.Workstations.GetWorkstationClusterCallback): void;
Calls GetWorkstationCluster.
Parameters | |
---|---|
Name | Description |
request |
google.cloud.workstations.v1beta.IGetWorkstationClusterRequest
GetWorkstationClusterRequest message or plain object |
callback |
google.cloud.workstations.v1beta.Workstations.GetWorkstationClusterCallback
Node-style callback called with the error, if any, and WorkstationCluster |
Returns | |
---|---|
Type | Description |
void |
getWorkstationCluster(request)
public getWorkstationCluster(request: google.cloud.workstations.v1beta.IGetWorkstationClusterRequest): Promise<google.cloud.workstations.v1beta.WorkstationCluster>;
Calls GetWorkstationCluster.
Parameter | |
---|---|
Name | Description |
request |
google.cloud.workstations.v1beta.IGetWorkstationClusterRequest
GetWorkstationClusterRequest message or plain object |
Returns | |
---|---|
Type | Description |
Promise<google.cloud.workstations.v1beta.WorkstationCluster> | Promise |
getWorkstationConfig(request, callback)
public getWorkstationConfig(request: google.cloud.workstations.v1beta.IGetWorkstationConfigRequest, callback: google.cloud.workstations.v1beta.Workstations.GetWorkstationConfigCallback): void;
Calls GetWorkstationConfig.
Parameters | |
---|---|
Name | Description |
request |
google.cloud.workstations.v1beta.IGetWorkstationConfigRequest
GetWorkstationConfigRequest message or plain object |
callback |
google.cloud.workstations.v1beta.Workstations.GetWorkstationConfigCallback
Node-style callback called with the error, if any, and WorkstationConfig |
Returns | |
---|---|
Type | Description |
void |
getWorkstationConfig(request)
public getWorkstationConfig(request: google.cloud.workstations.v1beta.IGetWorkstationConfigRequest): Promise<google.cloud.workstations.v1beta.WorkstationConfig>;
Calls GetWorkstationConfig.
Parameter | |
---|---|
Name | Description |
request |
google.cloud.workstations.v1beta.IGetWorkstationConfigRequest
GetWorkstationConfigRequest message or plain object |
Returns | |
---|---|
Type | Description |
Promise<google.cloud.workstations.v1beta.WorkstationConfig> | Promise |
listUsableWorkstationConfigs(request, callback)
public listUsableWorkstationConfigs(request: google.cloud.workstations.v1beta.IListUsableWorkstationConfigsRequest, callback: google.cloud.workstations.v1beta.Workstations.ListUsableWorkstationConfigsCallback): void;
Calls ListUsableWorkstationConfigs.
Parameters | |
---|---|
Name | Description |
request |
google.cloud.workstations.v1beta.IListUsableWorkstationConfigsRequest
ListUsableWorkstationConfigsRequest message or plain object |
callback |
google.cloud.workstations.v1beta.Workstations.ListUsableWorkstationConfigsCallback
Node-style callback called with the error, if any, and ListUsableWorkstationConfigsResponse |
Returns | |
---|---|
Type | Description |
void |
listUsableWorkstationConfigs(request)
public listUsableWorkstationConfigs(request: google.cloud.workstations.v1beta.IListUsableWorkstationConfigsRequest): Promise<google.cloud.workstations.v1beta.ListUsableWorkstationConfigsResponse>;
Calls ListUsableWorkstationConfigs.
Parameter | |
---|---|
Name | Description |
request |
google.cloud.workstations.v1beta.IListUsableWorkstationConfigsRequest
ListUsableWorkstationConfigsRequest message or plain object |
Returns | |
---|---|
Type | Description |
Promise<google.cloud.workstations.v1beta.ListUsableWorkstationConfigsResponse> | Promise |
listUsableWorkstations(request, callback)
public listUsableWorkstations(request: google.cloud.workstations.v1beta.IListUsableWorkstationsRequest, callback: google.cloud.workstations.v1beta.Workstations.ListUsableWorkstationsCallback): void;
Calls ListUsableWorkstations.
Parameters | |
---|---|
Name | Description |
request |
IListUsableWorkstationsRequest
ListUsableWorkstationsRequest message or plain object |
callback |
google.cloud.workstations.v1beta.Workstations.ListUsableWorkstationsCallback
Node-style callback called with the error, if any, and ListUsableWorkstationsResponse |
Returns | |
---|---|
Type | Description |
void |
listUsableWorkstations(request)
public listUsableWorkstations(request: google.cloud.workstations.v1beta.IListUsableWorkstationsRequest): Promise<google.cloud.workstations.v1beta.ListUsableWorkstationsResponse>;
Calls ListUsableWorkstations.
Parameter | |
---|---|
Name | Description |
request |
IListUsableWorkstationsRequest
ListUsableWorkstationsRequest message or plain object |
Returns | |
---|---|
Type | Description |
Promise<google.cloud.workstations.v1beta.ListUsableWorkstationsResponse> | Promise |
listWorkstationClusters(request, callback)
public listWorkstationClusters(request: google.cloud.workstations.v1beta.IListWorkstationClustersRequest, callback: google.cloud.workstations.v1beta.Workstations.ListWorkstationClustersCallback): void;
Calls ListWorkstationClusters.
Parameters | |
---|---|
Name | Description |
request |
google.cloud.workstations.v1beta.IListWorkstationClustersRequest
ListWorkstationClustersRequest message or plain object |
callback |
google.cloud.workstations.v1beta.Workstations.ListWorkstationClustersCallback
Node-style callback called with the error, if any, and ListWorkstationClustersResponse |
Returns | |
---|---|
Type | Description |
void |
listWorkstationClusters(request)
public listWorkstationClusters(request: google.cloud.workstations.v1beta.IListWorkstationClustersRequest): Promise<google.cloud.workstations.v1beta.ListWorkstationClustersResponse>;
Calls ListWorkstationClusters.
Parameter | |
---|---|
Name | Description |
request |
google.cloud.workstations.v1beta.IListWorkstationClustersRequest
ListWorkstationClustersRequest message or plain object |
Returns | |
---|---|
Type | Description |
Promise<google.cloud.workstations.v1beta.ListWorkstationClustersResponse> | Promise |
listWorkstationConfigs(request, callback)
public listWorkstationConfigs(request: google.cloud.workstations.v1beta.IListWorkstationConfigsRequest, callback: google.cloud.workstations.v1beta.Workstations.ListWorkstationConfigsCallback): void;
Calls ListWorkstationConfigs.
Parameters | |
---|---|
Name | Description |
request |
IListWorkstationConfigsRequest
ListWorkstationConfigsRequest message or plain object |
callback |
google.cloud.workstations.v1beta.Workstations.ListWorkstationConfigsCallback
Node-style callback called with the error, if any, and ListWorkstationConfigsResponse |
Returns | |
---|---|
Type | Description |
void |
listWorkstationConfigs(request)
public listWorkstationConfigs(request: google.cloud.workstations.v1beta.IListWorkstationConfigsRequest): Promise<google.cloud.workstations.v1beta.ListWorkstationConfigsResponse>;
Calls ListWorkstationConfigs.
Parameter | |
---|---|
Name | Description |
request |
IListWorkstationConfigsRequest
ListWorkstationConfigsRequest message or plain object |
Returns | |
---|---|
Type | Description |
Promise<google.cloud.workstations.v1beta.ListWorkstationConfigsResponse> | Promise |
listWorkstations(request, callback)
public listWorkstations(request: google.cloud.workstations.v1beta.IListWorkstationsRequest, callback: google.cloud.workstations.v1beta.Workstations.ListWorkstationsCallback): void;
Calls ListWorkstations.
Parameters | |
---|---|
Name | Description |
request |
google.cloud.workstations.v1beta.IListWorkstationsRequest
ListWorkstationsRequest message or plain object |
callback |
google.cloud.workstations.v1beta.Workstations.ListWorkstationsCallback
Node-style callback called with the error, if any, and ListWorkstationsResponse |
Returns | |
---|---|
Type | Description |
void |
listWorkstations(request)
public listWorkstations(request: google.cloud.workstations.v1beta.IListWorkstationsRequest): Promise<google.cloud.workstations.v1beta.ListWorkstationsResponse>;
Calls ListWorkstations.
Parameter | |
---|---|
Name | Description |
request |
google.cloud.workstations.v1beta.IListWorkstationsRequest
ListWorkstationsRequest message or plain object |
Returns | |
---|---|
Type | Description |
Promise<google.cloud.workstations.v1beta.ListWorkstationsResponse> | Promise |
startWorkstation(request, callback)
public startWorkstation(request: google.cloud.workstations.v1beta.IStartWorkstationRequest, callback: google.cloud.workstations.v1beta.Workstations.StartWorkstationCallback): void;
Calls StartWorkstation.
Parameters | |
---|---|
Name | Description |
request |
google.cloud.workstations.v1beta.IStartWorkstationRequest
StartWorkstationRequest message or plain object |
callback |
google.cloud.workstations.v1beta.Workstations.StartWorkstationCallback
Node-style callback called with the error, if any, and Operation |
Returns | |
---|---|
Type | Description |
void |
startWorkstation(request)
public startWorkstation(request: google.cloud.workstations.v1beta.IStartWorkstationRequest): Promise<google.longrunning.Operation>;
Calls StartWorkstation.
Parameter | |
---|---|
Name | Description |
request |
google.cloud.workstations.v1beta.IStartWorkstationRequest
StartWorkstationRequest message or plain object |
Returns | |
---|---|
Type | Description |
Promise<google.longrunning.Operation> | Promise |
stopWorkstation(request, callback)
public stopWorkstation(request: google.cloud.workstations.v1beta.IStopWorkstationRequest, callback: google.cloud.workstations.v1beta.Workstations.StopWorkstationCallback): void;
Calls StopWorkstation.
Parameters | |
---|---|
Name | Description |
request |
google.cloud.workstations.v1beta.IStopWorkstationRequest
StopWorkstationRequest message or plain object |
callback |
google.cloud.workstations.v1beta.Workstations.StopWorkstationCallback
Node-style callback called with the error, if any, and Operation |
Returns | |
---|---|
Type | Description |
void |
stopWorkstation(request)
public stopWorkstation(request: google.cloud.workstations.v1beta.IStopWorkstationRequest): Promise<google.longrunning.Operation>;
Calls StopWorkstation.
Parameter | |
---|---|
Name | Description |
request |
google.cloud.workstations.v1beta.IStopWorkstationRequest
StopWorkstationRequest message or plain object |
Returns | |
---|---|
Type | Description |
Promise<google.longrunning.Operation> | Promise |
updateWorkstation(request, callback)
public updateWorkstation(request: google.cloud.workstations.v1beta.IUpdateWorkstationRequest, callback: google.cloud.workstations.v1beta.Workstations.UpdateWorkstationCallback): void;
Calls UpdateWorkstation.
Parameters | |
---|---|
Name | Description |
request |
google.cloud.workstations.v1beta.IUpdateWorkstationRequest
UpdateWorkstationRequest message or plain object |
callback |
google.cloud.workstations.v1beta.Workstations.UpdateWorkstationCallback
Node-style callback called with the error, if any, and Operation |
Returns | |
---|---|
Type | Description |
void |
updateWorkstation(request)
public updateWorkstation(request: google.cloud.workstations.v1beta.IUpdateWorkstationRequest): Promise<google.longrunning.Operation>;
Calls UpdateWorkstation.
Parameter | |
---|---|
Name | Description |
request |
google.cloud.workstations.v1beta.IUpdateWorkstationRequest
UpdateWorkstationRequest message or plain object |
Returns | |
---|---|
Type | Description |
Promise<google.longrunning.Operation> | Promise |
updateWorkstationCluster(request, callback)
public updateWorkstationCluster(request: google.cloud.workstations.v1beta.IUpdateWorkstationClusterRequest, callback: google.cloud.workstations.v1beta.Workstations.UpdateWorkstationClusterCallback): void;
Calls UpdateWorkstationCluster.
Parameters | |
---|---|
Name | Description |
request |
google.cloud.workstations.v1beta.IUpdateWorkstationClusterRequest
UpdateWorkstationClusterRequest message or plain object |
callback |
google.cloud.workstations.v1beta.Workstations.UpdateWorkstationClusterCallback
Node-style callback called with the error, if any, and Operation |
Returns | |
---|---|
Type | Description |
void |
updateWorkstationCluster(request)
public updateWorkstationCluster(request: google.cloud.workstations.v1beta.IUpdateWorkstationClusterRequest): Promise<google.longrunning.Operation>;
Calls UpdateWorkstationCluster.
Parameter | |
---|---|
Name | Description |
request |
google.cloud.workstations.v1beta.IUpdateWorkstationClusterRequest
UpdateWorkstationClusterRequest message or plain object |
Returns | |
---|---|
Type | Description |
Promise<google.longrunning.Operation> | Promise |
updateWorkstationConfig(request, callback)
public updateWorkstationConfig(request: google.cloud.workstations.v1beta.IUpdateWorkstationConfigRequest, callback: google.cloud.workstations.v1beta.Workstations.UpdateWorkstationConfigCallback): void;
Calls UpdateWorkstationConfig.
Parameters | |
---|---|
Name | Description |
request |
google.cloud.workstations.v1beta.IUpdateWorkstationConfigRequest
UpdateWorkstationConfigRequest message or plain object |
callback |
google.cloud.workstations.v1beta.Workstations.UpdateWorkstationConfigCallback
Node-style callback called with the error, if any, and Operation |
Returns | |
---|---|
Type | Description |
void |
updateWorkstationConfig(request)
public updateWorkstationConfig(request: google.cloud.workstations.v1beta.IUpdateWorkstationConfigRequest): Promise<google.longrunning.Operation>;
Calls UpdateWorkstationConfig.
Parameter | |
---|---|
Name | Description |
request |
google.cloud.workstations.v1beta.IUpdateWorkstationConfigRequest
UpdateWorkstationConfigRequest message or plain object |
Returns | |
---|---|
Type | Description |
Promise<google.longrunning.Operation> | Promise |