Summary of entries of Methods for workstations.
google.cloud.workstations_v1.services.workstations.WorkstationsAsyncClient
WorkstationsAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.workstations_v1.services.workstations.transports.base.WorkstationsTransport, typing.Callable[[...], google.cloud.workstations_v1.services.workstations.transports.base.WorkstationsTransport]]] = 'grpc_asyncio', client_options: typing.Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo =
Instantiates the workstations async client.
See more: google.cloud.workstations_v1.services.workstations.WorkstationsAsyncClient
google.cloud.workstations_v1.services.workstations.WorkstationsAsyncClient.cancel_operation
cancel_operation(
request: typing.Optional[
google.longrunning.operations_pb2.CancelOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Starts asynchronous cancellation on a long-running operation.
See more: google.cloud.workstations_v1.services.workstations.WorkstationsAsyncClient.cancel_operation
google.cloud.workstations_v1.services.workstations.WorkstationsAsyncClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
google.cloud.workstations_v1.services.workstations.WorkstationsAsyncClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
See more: google.cloud.workstations_v1.services.workstations.WorkstationsAsyncClient.common_folder_path
google.cloud.workstations_v1.services.workstations.WorkstationsAsyncClient.common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
See more: google.cloud.workstations_v1.services.workstations.WorkstationsAsyncClient.common_location_path
google.cloud.workstations_v1.services.workstations.WorkstationsAsyncClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
See more: google.cloud.workstations_v1.services.workstations.WorkstationsAsyncClient.common_organization_path
google.cloud.workstations_v1.services.workstations.WorkstationsAsyncClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
See more: google.cloud.workstations_v1.services.workstations.WorkstationsAsyncClient.common_project_path
google.cloud.workstations_v1.services.workstations.WorkstationsAsyncClient.create_workstation
create_workstation(
request: typing.Optional[
typing.Union[
google.cloud.workstations_v1.types.workstations.CreateWorkstationRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
workstation: typing.Optional[
google.cloud.workstations_v1.types.workstations.Workstation
] = None,
workstation_id: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Creates a new workstation.
See more: google.cloud.workstations_v1.services.workstations.WorkstationsAsyncClient.create_workstation
google.cloud.workstations_v1.services.workstations.WorkstationsAsyncClient.create_workstation_cluster
create_workstation_cluster(
request: typing.Optional[
typing.Union[
google.cloud.workstations_v1.types.workstations.CreateWorkstationClusterRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
workstation_cluster: typing.Optional[
google.cloud.workstations_v1.types.workstations.WorkstationCluster
] = None,
workstation_cluster_id: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Creates a new workstation cluster.
google.cloud.workstations_v1.services.workstations.WorkstationsAsyncClient.create_workstation_config
create_workstation_config(
request: typing.Optional[
typing.Union[
google.cloud.workstations_v1.types.workstations.CreateWorkstationConfigRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
workstation_config: typing.Optional[
google.cloud.workstations_v1.types.workstations.WorkstationConfig
] = None,
workstation_config_id: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Creates a new workstation configuration.
See more: google.cloud.workstations_v1.services.workstations.WorkstationsAsyncClient.create_workstation_config
google.cloud.workstations_v1.services.workstations.WorkstationsAsyncClient.delete_operation
delete_operation(
request: typing.Optional[
google.longrunning.operations_pb2.DeleteOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Deletes a long-running operation.
See more: google.cloud.workstations_v1.services.workstations.WorkstationsAsyncClient.delete_operation
google.cloud.workstations_v1.services.workstations.WorkstationsAsyncClient.delete_workstation
delete_workstation(
request: typing.Optional[
typing.Union[
google.cloud.workstations_v1.types.workstations.DeleteWorkstationRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Deletes the specified workstation.
See more: google.cloud.workstations_v1.services.workstations.WorkstationsAsyncClient.delete_workstation
google.cloud.workstations_v1.services.workstations.WorkstationsAsyncClient.delete_workstation_cluster
delete_workstation_cluster(
request: typing.Optional[
typing.Union[
google.cloud.workstations_v1.types.workstations.DeleteWorkstationClusterRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Deletes the specified workstation cluster.
google.cloud.workstations_v1.services.workstations.WorkstationsAsyncClient.delete_workstation_config
delete_workstation_config(
request: typing.Optional[
typing.Union[
google.cloud.workstations_v1.types.workstations.DeleteWorkstationConfigRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Deletes the specified workstation configuration.
See more: google.cloud.workstations_v1.services.workstations.WorkstationsAsyncClient.delete_workstation_config
google.cloud.workstations_v1.services.workstations.WorkstationsAsyncClient.from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
See more: google.cloud.workstations_v1.services.workstations.WorkstationsAsyncClient.from_service_account_file
google.cloud.workstations_v1.services.workstations.WorkstationsAsyncClient.from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)
Creates an instance of this client using the provided credentials info.
See more: google.cloud.workstations_v1.services.workstations.WorkstationsAsyncClient.from_service_account_info
google.cloud.workstations_v1.services.workstations.WorkstationsAsyncClient.from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
See more: google.cloud.workstations_v1.services.workstations.WorkstationsAsyncClient.from_service_account_json
google.cloud.workstations_v1.services.workstations.WorkstationsAsyncClient.generate_access_token
generate_access_token(
request: typing.Optional[
typing.Union[
google.cloud.workstations_v1.types.workstations.GenerateAccessTokenRequest,
dict,
]
] = None,
*,
workstation: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.workstations_v1.types.workstations.GenerateAccessTokenResponse
Returns a short-lived credential that can be used to send authenticated and authorized traffic to a workstation.
See more: google.cloud.workstations_v1.services.workstations.WorkstationsAsyncClient.generate_access_token
google.cloud.workstations_v1.services.workstations.WorkstationsAsyncClient.get_iam_policy
get_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Gets the IAM access control policy for a function.
See more: google.cloud.workstations_v1.services.workstations.WorkstationsAsyncClient.get_iam_policy
google.cloud.workstations_v1.services.workstations.WorkstationsAsyncClient.get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: typing.Optional[
google.api_core.client_options.ClientOptions
] = None,
)
Return the API endpoint and client cert source for mutual TLS.
google.cloud.workstations_v1.services.workstations.WorkstationsAsyncClient.get_operation
get_operation(
request: typing.Optional[
google.longrunning.operations_pb2.GetOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Gets the latest state of a long-running operation.
See more: google.cloud.workstations_v1.services.workstations.WorkstationsAsyncClient.get_operation
google.cloud.workstations_v1.services.workstations.WorkstationsAsyncClient.get_transport_class
get_transport_class(
label: typing.Optional[str] = None,
) -> typing.Type[
google.cloud.workstations_v1.services.workstations.transports.base.WorkstationsTransport
]
Returns an appropriate transport class.
See more: google.cloud.workstations_v1.services.workstations.WorkstationsAsyncClient.get_transport_class
google.cloud.workstations_v1.services.workstations.WorkstationsAsyncClient.get_workstation
get_workstation(
request: typing.Optional[
typing.Union[
google.cloud.workstations_v1.types.workstations.GetWorkstationRequest, dict
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.workstations_v1.types.workstations.Workstation
Returns the requested workstation.
See more: google.cloud.workstations_v1.services.workstations.WorkstationsAsyncClient.get_workstation
google.cloud.workstations_v1.services.workstations.WorkstationsAsyncClient.get_workstation_cluster
get_workstation_cluster(
request: typing.Optional[
typing.Union[
google.cloud.workstations_v1.types.workstations.GetWorkstationClusterRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.workstations_v1.types.workstations.WorkstationCluster
Returns the requested workstation cluster.
See more: google.cloud.workstations_v1.services.workstations.WorkstationsAsyncClient.get_workstation_cluster
google.cloud.workstations_v1.services.workstations.WorkstationsAsyncClient.get_workstation_config
get_workstation_config(
request: typing.Optional[
typing.Union[
google.cloud.workstations_v1.types.workstations.GetWorkstationConfigRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.workstations_v1.types.workstations.WorkstationConfig
Returns the requested workstation configuration.
See more: google.cloud.workstations_v1.services.workstations.WorkstationsAsyncClient.get_workstation_config
google.cloud.workstations_v1.services.workstations.WorkstationsAsyncClient.list_operations
list_operations(
request: typing.Optional[
google.longrunning.operations_pb2.ListOperationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse
Lists operations that match the specified filter in the request.
See more: google.cloud.workstations_v1.services.workstations.WorkstationsAsyncClient.list_operations
google.cloud.workstations_v1.services.workstations.WorkstationsAsyncClient.list_usable_workstation_configs
list_usable_workstation_configs(
request: typing.Optional[
typing.Union[
google.cloud.workstations_v1.types.workstations.ListUsableWorkstationConfigsRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.workstations_v1.services.workstations.pagers.ListUsableWorkstationConfigsAsyncPager
)
Returns all workstation configurations in the specified cluster on which the caller has the "workstations.workstation.create" permission.
google.cloud.workstations_v1.services.workstations.WorkstationsAsyncClient.list_usable_workstations
list_usable_workstations(
request: typing.Optional[
typing.Union[
google.cloud.workstations_v1.types.workstations.ListUsableWorkstationsRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.workstations_v1.services.workstations.pagers.ListUsableWorkstationsAsyncPager
)
Returns all workstations using the specified workstation configuration on which the caller has the "workstations.workstations.use" permission.
See more: google.cloud.workstations_v1.services.workstations.WorkstationsAsyncClient.list_usable_workstations
google.cloud.workstations_v1.services.workstations.WorkstationsAsyncClient.list_workstation_clusters
list_workstation_clusters(
request: typing.Optional[
typing.Union[
google.cloud.workstations_v1.types.workstations.ListWorkstationClustersRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.workstations_v1.services.workstations.pagers.ListWorkstationClustersAsyncPager
)
Returns all workstation clusters in the specified location.
See more: google.cloud.workstations_v1.services.workstations.WorkstationsAsyncClient.list_workstation_clusters
google.cloud.workstations_v1.services.workstations.WorkstationsAsyncClient.list_workstation_configs
list_workstation_configs(
request: typing.Optional[
typing.Union[
google.cloud.workstations_v1.types.workstations.ListWorkstationConfigsRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.workstations_v1.services.workstations.pagers.ListWorkstationConfigsAsyncPager
)
Returns all workstation configurations in the specified cluster.
See more: google.cloud.workstations_v1.services.workstations.WorkstationsAsyncClient.list_workstation_configs
google.cloud.workstations_v1.services.workstations.WorkstationsAsyncClient.list_workstations
list_workstations(
request: typing.Optional[
typing.Union[
google.cloud.workstations_v1.types.workstations.ListWorkstationsRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.workstations_v1.services.workstations.pagers.ListWorkstationsAsyncPager
)
Returns all Workstations using the specified workstation configuration.
See more: google.cloud.workstations_v1.services.workstations.WorkstationsAsyncClient.list_workstations
google.cloud.workstations_v1.services.workstations.WorkstationsAsyncClient.parse_common_billing_account_path
parse_common_billing_account_path(path: str) -> typing.Dict[str, str]
Parse a billing_account path into its component segments.
google.cloud.workstations_v1.services.workstations.WorkstationsAsyncClient.parse_common_folder_path
parse_common_folder_path(path: str) -> typing.Dict[str, str]
Parse a folder path into its component segments.
See more: google.cloud.workstations_v1.services.workstations.WorkstationsAsyncClient.parse_common_folder_path
google.cloud.workstations_v1.services.workstations.WorkstationsAsyncClient.parse_common_location_path
parse_common_location_path(path: str) -> typing.Dict[str, str]
Parse a location path into its component segments.
google.cloud.workstations_v1.services.workstations.WorkstationsAsyncClient.parse_common_organization_path
parse_common_organization_path(path: str) -> typing.Dict[str, str]
Parse a organization path into its component segments.
google.cloud.workstations_v1.services.workstations.WorkstationsAsyncClient.parse_common_project_path
parse_common_project_path(path: str) -> typing.Dict[str, str]
Parse a project path into its component segments.
See more: google.cloud.workstations_v1.services.workstations.WorkstationsAsyncClient.parse_common_project_path
google.cloud.workstations_v1.services.workstations.WorkstationsAsyncClient.parse_workstation_cluster_path
parse_workstation_cluster_path(path: str) -> typing.Dict[str, str]
Parses a workstation_cluster path into its component segments.
google.cloud.workstations_v1.services.workstations.WorkstationsAsyncClient.parse_workstation_config_path
parse_workstation_config_path(path: str) -> typing.Dict[str, str]
Parses a workstation_config path into its component segments.
google.cloud.workstations_v1.services.workstations.WorkstationsAsyncClient.parse_workstation_path
parse_workstation_path(path: str) -> typing.Dict[str, str]
Parses a workstation path into its component segments.
See more: google.cloud.workstations_v1.services.workstations.WorkstationsAsyncClient.parse_workstation_path
google.cloud.workstations_v1.services.workstations.WorkstationsAsyncClient.set_iam_policy
set_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Sets the IAM access control policy on the specified function.
See more: google.cloud.workstations_v1.services.workstations.WorkstationsAsyncClient.set_iam_policy
google.cloud.workstations_v1.services.workstations.WorkstationsAsyncClient.start_workstation
start_workstation(
request: typing.Optional[
typing.Union[
google.cloud.workstations_v1.types.workstations.StartWorkstationRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Starts running a workstation so that users can connect to it.
See more: google.cloud.workstations_v1.services.workstations.WorkstationsAsyncClient.start_workstation
google.cloud.workstations_v1.services.workstations.WorkstationsAsyncClient.stop_workstation
stop_workstation(
request: typing.Optional[
typing.Union[
google.cloud.workstations_v1.types.workstations.StopWorkstationRequest, dict
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Stops running a workstation, reducing costs.
See more: google.cloud.workstations_v1.services.workstations.WorkstationsAsyncClient.stop_workstation
google.cloud.workstations_v1.services.workstations.WorkstationsAsyncClient.test_iam_permissions
test_iam_permissions(
request: typing.Optional[
google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.iam_policy_pb2.TestIamPermissionsResponse
Tests the specified IAM permissions against the IAM access control policy for a function.
See more: google.cloud.workstations_v1.services.workstations.WorkstationsAsyncClient.test_iam_permissions
google.cloud.workstations_v1.services.workstations.WorkstationsAsyncClient.update_workstation
update_workstation(
request: typing.Optional[
typing.Union[
google.cloud.workstations_v1.types.workstations.UpdateWorkstationRequest,
dict,
]
] = None,
*,
workstation: typing.Optional[
google.cloud.workstations_v1.types.workstations.Workstation
] = None,
update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Updates an existing workstation.
See more: google.cloud.workstations_v1.services.workstations.WorkstationsAsyncClient.update_workstation
google.cloud.workstations_v1.services.workstations.WorkstationsAsyncClient.update_workstation_cluster
update_workstation_cluster(
request: typing.Optional[
typing.Union[
google.cloud.workstations_v1.types.workstations.UpdateWorkstationClusterRequest,
dict,
]
] = None,
*,
workstation_cluster: typing.Optional[
google.cloud.workstations_v1.types.workstations.WorkstationCluster
] = None,
update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Updates an existing workstation cluster.
google.cloud.workstations_v1.services.workstations.WorkstationsAsyncClient.update_workstation_config
update_workstation_config(
request: typing.Optional[
typing.Union[
google.cloud.workstations_v1.types.workstations.UpdateWorkstationConfigRequest,
dict,
]
] = None,
*,
workstation_config: typing.Optional[
google.cloud.workstations_v1.types.workstations.WorkstationConfig
] = None,
update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Updates an existing workstation configuration.
See more: google.cloud.workstations_v1.services.workstations.WorkstationsAsyncClient.update_workstation_config
google.cloud.workstations_v1.services.workstations.WorkstationsAsyncClient.workstation_cluster_path
workstation_cluster_path(
project: str, location: str, workstation_cluster: str
) -> str
Returns a fully-qualified workstation_cluster string.
See more: google.cloud.workstations_v1.services.workstations.WorkstationsAsyncClient.workstation_cluster_path
google.cloud.workstations_v1.services.workstations.WorkstationsAsyncClient.workstation_config_path
workstation_config_path(
project: str, location: str, workstation_cluster: str, workstation_config: str
) -> str
Returns a fully-qualified workstation_config string.
See more: google.cloud.workstations_v1.services.workstations.WorkstationsAsyncClient.workstation_config_path
google.cloud.workstations_v1.services.workstations.WorkstationsAsyncClient.workstation_path
workstation_path(
project: str,
location: str,
workstation_cluster: str,
workstation_config: str,
workstation: str,
) -> str
Returns a fully-qualified workstation string.
See more: google.cloud.workstations_v1.services.workstations.WorkstationsAsyncClient.workstation_path
google.cloud.workstations_v1.services.workstations.WorkstationsClient
WorkstationsClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.workstations_v1.services.workstations.transports.base.WorkstationsTransport, typing.Callable[[...], google.cloud.workstations_v1.services.workstations.transports.base.WorkstationsTransport]]] = None, client_options: typing.Optional[typing.Union[google.api_core.client_options.ClientOptions, dict]] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo =
Instantiates the workstations client.
See more: google.cloud.workstations_v1.services.workstations.WorkstationsClient
google.cloud.workstations_v1.services.workstations.WorkstationsClient.__exit__
__exit__(type, value, traceback)
Releases underlying transport's resources.
See more: google.cloud.workstations_v1.services.workstations.WorkstationsClient.exit
google.cloud.workstations_v1.services.workstations.WorkstationsClient.cancel_operation
cancel_operation(
request: typing.Optional[
google.longrunning.operations_pb2.CancelOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Starts asynchronous cancellation on a long-running operation.
See more: google.cloud.workstations_v1.services.workstations.WorkstationsClient.cancel_operation
google.cloud.workstations_v1.services.workstations.WorkstationsClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
See more: google.cloud.workstations_v1.services.workstations.WorkstationsClient.common_billing_account_path
google.cloud.workstations_v1.services.workstations.WorkstationsClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
See more: google.cloud.workstations_v1.services.workstations.WorkstationsClient.common_folder_path
google.cloud.workstations_v1.services.workstations.WorkstationsClient.common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
See more: google.cloud.workstations_v1.services.workstations.WorkstationsClient.common_location_path
google.cloud.workstations_v1.services.workstations.WorkstationsClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
See more: google.cloud.workstations_v1.services.workstations.WorkstationsClient.common_organization_path
google.cloud.workstations_v1.services.workstations.WorkstationsClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
See more: google.cloud.workstations_v1.services.workstations.WorkstationsClient.common_project_path
google.cloud.workstations_v1.services.workstations.WorkstationsClient.create_workstation
create_workstation(
request: typing.Optional[
typing.Union[
google.cloud.workstations_v1.types.workstations.CreateWorkstationRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
workstation: typing.Optional[
google.cloud.workstations_v1.types.workstations.Workstation
] = None,
workstation_id: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Creates a new workstation.
See more: google.cloud.workstations_v1.services.workstations.WorkstationsClient.create_workstation
google.cloud.workstations_v1.services.workstations.WorkstationsClient.create_workstation_cluster
create_workstation_cluster(
request: typing.Optional[
typing.Union[
google.cloud.workstations_v1.types.workstations.CreateWorkstationClusterRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
workstation_cluster: typing.Optional[
google.cloud.workstations_v1.types.workstations.WorkstationCluster
] = None,
workstation_cluster_id: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Creates a new workstation cluster.
See more: google.cloud.workstations_v1.services.workstations.WorkstationsClient.create_workstation_cluster
google.cloud.workstations_v1.services.workstations.WorkstationsClient.create_workstation_config
create_workstation_config(
request: typing.Optional[
typing.Union[
google.cloud.workstations_v1.types.workstations.CreateWorkstationConfigRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
workstation_config: typing.Optional[
google.cloud.workstations_v1.types.workstations.WorkstationConfig
] = None,
workstation_config_id: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Creates a new workstation configuration.
See more: google.cloud.workstations_v1.services.workstations.WorkstationsClient.create_workstation_config
google.cloud.workstations_v1.services.workstations.WorkstationsClient.delete_operation
delete_operation(
request: typing.Optional[
google.longrunning.operations_pb2.DeleteOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Deletes a long-running operation.
See more: google.cloud.workstations_v1.services.workstations.WorkstationsClient.delete_operation
google.cloud.workstations_v1.services.workstations.WorkstationsClient.delete_workstation
delete_workstation(
request: typing.Optional[
typing.Union[
google.cloud.workstations_v1.types.workstations.DeleteWorkstationRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Deletes the specified workstation.
See more: google.cloud.workstations_v1.services.workstations.WorkstationsClient.delete_workstation
google.cloud.workstations_v1.services.workstations.WorkstationsClient.delete_workstation_cluster
delete_workstation_cluster(
request: typing.Optional[
typing.Union[
google.cloud.workstations_v1.types.workstations.DeleteWorkstationClusterRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Deletes the specified workstation cluster.
See more: google.cloud.workstations_v1.services.workstations.WorkstationsClient.delete_workstation_cluster
google.cloud.workstations_v1.services.workstations.WorkstationsClient.delete_workstation_config
delete_workstation_config(
request: typing.Optional[
typing.Union[
google.cloud.workstations_v1.types.workstations.DeleteWorkstationConfigRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Deletes the specified workstation configuration.
See more: google.cloud.workstations_v1.services.workstations.WorkstationsClient.delete_workstation_config
google.cloud.workstations_v1.services.workstations.WorkstationsClient.from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
See more: google.cloud.workstations_v1.services.workstations.WorkstationsClient.from_service_account_file
google.cloud.workstations_v1.services.workstations.WorkstationsClient.from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)
Creates an instance of this client using the provided credentials info.
See more: google.cloud.workstations_v1.services.workstations.WorkstationsClient.from_service_account_info
google.cloud.workstations_v1.services.workstations.WorkstationsClient.from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
See more: google.cloud.workstations_v1.services.workstations.WorkstationsClient.from_service_account_json
google.cloud.workstations_v1.services.workstations.WorkstationsClient.generate_access_token
generate_access_token(
request: typing.Optional[
typing.Union[
google.cloud.workstations_v1.types.workstations.GenerateAccessTokenRequest,
dict,
]
] = None,
*,
workstation: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.workstations_v1.types.workstations.GenerateAccessTokenResponse
Returns a short-lived credential that can be used to send authenticated and authorized traffic to a workstation.
See more: google.cloud.workstations_v1.services.workstations.WorkstationsClient.generate_access_token
google.cloud.workstations_v1.services.workstations.WorkstationsClient.get_iam_policy
get_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Gets the IAM access control policy for a function.
See more: google.cloud.workstations_v1.services.workstations.WorkstationsClient.get_iam_policy
google.cloud.workstations_v1.services.workstations.WorkstationsClient.get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: typing.Optional[
google.api_core.client_options.ClientOptions
] = None,
)
Deprecated.
google.cloud.workstations_v1.services.workstations.WorkstationsClient.get_operation
get_operation(
request: typing.Optional[
google.longrunning.operations_pb2.GetOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Gets the latest state of a long-running operation.
See more: google.cloud.workstations_v1.services.workstations.WorkstationsClient.get_operation
google.cloud.workstations_v1.services.workstations.WorkstationsClient.get_workstation
get_workstation(
request: typing.Optional[
typing.Union[
google.cloud.workstations_v1.types.workstations.GetWorkstationRequest, dict
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.workstations_v1.types.workstations.Workstation
Returns the requested workstation.
See more: google.cloud.workstations_v1.services.workstations.WorkstationsClient.get_workstation
google.cloud.workstations_v1.services.workstations.WorkstationsClient.get_workstation_cluster
get_workstation_cluster(
request: typing.Optional[
typing.Union[
google.cloud.workstations_v1.types.workstations.GetWorkstationClusterRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.workstations_v1.types.workstations.WorkstationCluster
Returns the requested workstation cluster.
See more: google.cloud.workstations_v1.services.workstations.WorkstationsClient.get_workstation_cluster
google.cloud.workstations_v1.services.workstations.WorkstationsClient.get_workstation_config
get_workstation_config(
request: typing.Optional[
typing.Union[
google.cloud.workstations_v1.types.workstations.GetWorkstationConfigRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.workstations_v1.types.workstations.WorkstationConfig
Returns the requested workstation configuration.
See more: google.cloud.workstations_v1.services.workstations.WorkstationsClient.get_workstation_config
google.cloud.workstations_v1.services.workstations.WorkstationsClient.list_operations
list_operations(
request: typing.Optional[
google.longrunning.operations_pb2.ListOperationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse
Lists operations that match the specified filter in the request.
See more: google.cloud.workstations_v1.services.workstations.WorkstationsClient.list_operations
google.cloud.workstations_v1.services.workstations.WorkstationsClient.list_usable_workstation_configs
list_usable_workstation_configs(
request: typing.Optional[
typing.Union[
google.cloud.workstations_v1.types.workstations.ListUsableWorkstationConfigsRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.workstations_v1.services.workstations.pagers.ListUsableWorkstationConfigsPager
)
Returns all workstation configurations in the specified cluster on which the caller has the "workstations.workstation.create" permission.
google.cloud.workstations_v1.services.workstations.WorkstationsClient.list_usable_workstations
list_usable_workstations(
request: typing.Optional[
typing.Union[
google.cloud.workstations_v1.types.workstations.ListUsableWorkstationsRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.workstations_v1.services.workstations.pagers.ListUsableWorkstationsPager
)
Returns all workstations using the specified workstation configuration on which the caller has the "workstations.workstations.use" permission.
See more: google.cloud.workstations_v1.services.workstations.WorkstationsClient.list_usable_workstations
google.cloud.workstations_v1.services.workstations.WorkstationsClient.list_workstation_clusters
list_workstation_clusters(
request: typing.Optional[
typing.Union[
google.cloud.workstations_v1.types.workstations.ListWorkstationClustersRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.workstations_v1.services.workstations.pagers.ListWorkstationClustersPager
)
Returns all workstation clusters in the specified location.
See more: google.cloud.workstations_v1.services.workstations.WorkstationsClient.list_workstation_clusters
google.cloud.workstations_v1.services.workstations.WorkstationsClient.list_workstation_configs
list_workstation_configs(
request: typing.Optional[
typing.Union[
google.cloud.workstations_v1.types.workstations.ListWorkstationConfigsRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.workstations_v1.services.workstations.pagers.ListWorkstationConfigsPager
)
Returns all workstation configurations in the specified cluster.
See more: google.cloud.workstations_v1.services.workstations.WorkstationsClient.list_workstation_configs
google.cloud.workstations_v1.services.workstations.WorkstationsClient.list_workstations
list_workstations(
request: typing.Optional[
typing.Union[
google.cloud.workstations_v1.types.workstations.ListWorkstationsRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.workstations_v1.services.workstations.pagers.ListWorkstationsPager
Returns all Workstations using the specified workstation configuration.
See more: google.cloud.workstations_v1.services.workstations.WorkstationsClient.list_workstations
google.cloud.workstations_v1.services.workstations.WorkstationsClient.parse_common_billing_account_path
parse_common_billing_account_path(path: str) -> typing.Dict[str, str]
Parse a billing_account path into its component segments.
google.cloud.workstations_v1.services.workstations.WorkstationsClient.parse_common_folder_path
parse_common_folder_path(path: str) -> typing.Dict[str, str]
Parse a folder path into its component segments.
See more: google.cloud.workstations_v1.services.workstations.WorkstationsClient.parse_common_folder_path
google.cloud.workstations_v1.services.workstations.WorkstationsClient.parse_common_location_path
parse_common_location_path(path: str) -> typing.Dict[str, str]
Parse a location path into its component segments.
See more: google.cloud.workstations_v1.services.workstations.WorkstationsClient.parse_common_location_path
google.cloud.workstations_v1.services.workstations.WorkstationsClient.parse_common_organization_path
parse_common_organization_path(path: str) -> typing.Dict[str, str]
Parse a organization path into its component segments.
See more: google.cloud.workstations_v1.services.workstations.WorkstationsClient.parse_common_organization_path
google.cloud.workstations_v1.services.workstations.WorkstationsClient.parse_common_project_path
parse_common_project_path(path: str) -> typing.Dict[str, str]
Parse a project path into its component segments.
See more: google.cloud.workstations_v1.services.workstations.WorkstationsClient.parse_common_project_path
google.cloud.workstations_v1.services.workstations.WorkstationsClient.parse_workstation_cluster_path
parse_workstation_cluster_path(path: str) -> typing.Dict[str, str]
Parses a workstation_cluster path into its component segments.
See more: google.cloud.workstations_v1.services.workstations.WorkstationsClient.parse_workstation_cluster_path
google.cloud.workstations_v1.services.workstations.WorkstationsClient.parse_workstation_config_path
parse_workstation_config_path(path: str) -> typing.Dict[str, str]
Parses a workstation_config path into its component segments.
See more: google.cloud.workstations_v1.services.workstations.WorkstationsClient.parse_workstation_config_path
google.cloud.workstations_v1.services.workstations.WorkstationsClient.parse_workstation_path
parse_workstation_path(path: str) -> typing.Dict[str, str]
Parses a workstation path into its component segments.
See more: google.cloud.workstations_v1.services.workstations.WorkstationsClient.parse_workstation_path
google.cloud.workstations_v1.services.workstations.WorkstationsClient.set_iam_policy
set_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Sets the IAM access control policy on the specified function.
See more: google.cloud.workstations_v1.services.workstations.WorkstationsClient.set_iam_policy
google.cloud.workstations_v1.services.workstations.WorkstationsClient.start_workstation
start_workstation(
request: typing.Optional[
typing.Union[
google.cloud.workstations_v1.types.workstations.StartWorkstationRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Starts running a workstation so that users can connect to it.
See more: google.cloud.workstations_v1.services.workstations.WorkstationsClient.start_workstation
google.cloud.workstations_v1.services.workstations.WorkstationsClient.stop_workstation
stop_workstation(
request: typing.Optional[
typing.Union[
google.cloud.workstations_v1.types.workstations.StopWorkstationRequest, dict
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Stops running a workstation, reducing costs.
See more: google.cloud.workstations_v1.services.workstations.WorkstationsClient.stop_workstation
google.cloud.workstations_v1.services.workstations.WorkstationsClient.test_iam_permissions
test_iam_permissions(
request: typing.Optional[
google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.iam_policy_pb2.TestIamPermissionsResponse
Tests the specified IAM permissions against the IAM access control policy for a function.
See more: google.cloud.workstations_v1.services.workstations.WorkstationsClient.test_iam_permissions
google.cloud.workstations_v1.services.workstations.WorkstationsClient.update_workstation
update_workstation(
request: typing.Optional[
typing.Union[
google.cloud.workstations_v1.types.workstations.UpdateWorkstationRequest,
dict,
]
] = None,
*,
workstation: typing.Optional[
google.cloud.workstations_v1.types.workstations.Workstation
] = None,
update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Updates an existing workstation.
See more: google.cloud.workstations_v1.services.workstations.WorkstationsClient.update_workstation
google.cloud.workstations_v1.services.workstations.WorkstationsClient.update_workstation_cluster
update_workstation_cluster(
request: typing.Optional[
typing.Union[
google.cloud.workstations_v1.types.workstations.UpdateWorkstationClusterRequest,
dict,
]
] = None,
*,
workstation_cluster: typing.Optional[
google.cloud.workstations_v1.types.workstations.WorkstationCluster
] = None,
update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Updates an existing workstation cluster.
See more: google.cloud.workstations_v1.services.workstations.WorkstationsClient.update_workstation_cluster
google.cloud.workstations_v1.services.workstations.WorkstationsClient.update_workstation_config
update_workstation_config(
request: typing.Optional[
typing.Union[
google.cloud.workstations_v1.types.workstations.UpdateWorkstationConfigRequest,
dict,
]
] = None,
*,
workstation_config: typing.Optional[
google.cloud.workstations_v1.types.workstations.WorkstationConfig
] = None,
update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Updates an existing workstation configuration.
See more: google.cloud.workstations_v1.services.workstations.WorkstationsClient.update_workstation_config
google.cloud.workstations_v1.services.workstations.WorkstationsClient.workstation_cluster_path
workstation_cluster_path(
project: str, location: str, workstation_cluster: str
) -> str
Returns a fully-qualified workstation_cluster string.
See more: google.cloud.workstations_v1.services.workstations.WorkstationsClient.workstation_cluster_path
google.cloud.workstations_v1.services.workstations.WorkstationsClient.workstation_config_path
workstation_config_path(
project: str, location: str, workstation_cluster: str, workstation_config: str
) -> str
Returns a fully-qualified workstation_config string.
See more: google.cloud.workstations_v1.services.workstations.WorkstationsClient.workstation_config_path
google.cloud.workstations_v1.services.workstations.WorkstationsClient.workstation_path
workstation_path(
project: str,
location: str,
workstation_cluster: str,
workstation_config: str,
workstation: str,
) -> str
Returns a fully-qualified workstation string.
See more: google.cloud.workstations_v1.services.workstations.WorkstationsClient.workstation_path
google.cloud.workstations_v1.services.workstations.pagers.ListUsableWorkstationConfigsAsyncPager
ListUsableWorkstationConfigsAsyncPager(
method: typing.Callable[
[...],
typing.Awaitable[
google.cloud.workstations_v1.types.workstations.ListUsableWorkstationConfigsResponse
],
],
request: google.cloud.workstations_v1.types.workstations.ListUsableWorkstationConfigsRequest,
response: google.cloud.workstations_v1.types.workstations.ListUsableWorkstationConfigsResponse,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiates the pager.
See more: google.cloud.workstations_v1.services.workstations.pagers.ListUsableWorkstationConfigsAsyncPager
google.cloud.workstations_v1.services.workstations.pagers.ListUsableWorkstationConfigsPager
ListUsableWorkstationConfigsPager(
method: typing.Callable[
[...],
google.cloud.workstations_v1.types.workstations.ListUsableWorkstationConfigsResponse,
],
request: google.cloud.workstations_v1.types.workstations.ListUsableWorkstationConfigsRequest,
response: google.cloud.workstations_v1.types.workstations.ListUsableWorkstationConfigsResponse,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiate the pager.
See more: google.cloud.workstations_v1.services.workstations.pagers.ListUsableWorkstationConfigsPager
google.cloud.workstations_v1.services.workstations.pagers.ListUsableWorkstationsAsyncPager
ListUsableWorkstationsAsyncPager(
method: typing.Callable[
[...],
typing.Awaitable[
google.cloud.workstations_v1.types.workstations.ListUsableWorkstationsResponse
],
],
request: google.cloud.workstations_v1.types.workstations.ListUsableWorkstationsRequest,
response: google.cloud.workstations_v1.types.workstations.ListUsableWorkstationsResponse,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiates the pager.
See more: google.cloud.workstations_v1.services.workstations.pagers.ListUsableWorkstationsAsyncPager
google.cloud.workstations_v1.services.workstations.pagers.ListUsableWorkstationsPager
ListUsableWorkstationsPager(
method: typing.Callable[
[...],
google.cloud.workstations_v1.types.workstations.ListUsableWorkstationsResponse,
],
request: google.cloud.workstations_v1.types.workstations.ListUsableWorkstationsRequest,
response: google.cloud.workstations_v1.types.workstations.ListUsableWorkstationsResponse,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiate the pager.
See more: google.cloud.workstations_v1.services.workstations.pagers.ListUsableWorkstationsPager
google.cloud.workstations_v1.services.workstations.pagers.ListWorkstationClustersAsyncPager
ListWorkstationClustersAsyncPager(
method: typing.Callable[
[...],
typing.Awaitable[
google.cloud.workstations_v1.types.workstations.ListWorkstationClustersResponse
],
],
request: google.cloud.workstations_v1.types.workstations.ListWorkstationClustersRequest,
response: google.cloud.workstations_v1.types.workstations.ListWorkstationClustersResponse,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiates the pager.
See more: google.cloud.workstations_v1.services.workstations.pagers.ListWorkstationClustersAsyncPager
google.cloud.workstations_v1.services.workstations.pagers.ListWorkstationClustersPager
ListWorkstationClustersPager(
method: typing.Callable[
[...],
google.cloud.workstations_v1.types.workstations.ListWorkstationClustersResponse,
],
request: google.cloud.workstations_v1.types.workstations.ListWorkstationClustersRequest,
response: google.cloud.workstations_v1.types.workstations.ListWorkstationClustersResponse,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiate the pager.
See more: google.cloud.workstations_v1.services.workstations.pagers.ListWorkstationClustersPager
google.cloud.workstations_v1.services.workstations.pagers.ListWorkstationConfigsAsyncPager
ListWorkstationConfigsAsyncPager(
method: typing.Callable[
[...],
typing.Awaitable[
google.cloud.workstations_v1.types.workstations.ListWorkstationConfigsResponse
],
],
request: google.cloud.workstations_v1.types.workstations.ListWorkstationConfigsRequest,
response: google.cloud.workstations_v1.types.workstations.ListWorkstationConfigsResponse,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiates the pager.
See more: google.cloud.workstations_v1.services.workstations.pagers.ListWorkstationConfigsAsyncPager
google.cloud.workstations_v1.services.workstations.pagers.ListWorkstationConfigsPager
ListWorkstationConfigsPager(
method: typing.Callable[
[...],
google.cloud.workstations_v1.types.workstations.ListWorkstationConfigsResponse,
],
request: google.cloud.workstations_v1.types.workstations.ListWorkstationConfigsRequest,
response: google.cloud.workstations_v1.types.workstations.ListWorkstationConfigsResponse,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiate the pager.
See more: google.cloud.workstations_v1.services.workstations.pagers.ListWorkstationConfigsPager
google.cloud.workstations_v1.services.workstations.pagers.ListWorkstationsAsyncPager
ListWorkstationsAsyncPager(
method: typing.Callable[
[...],
typing.Awaitable[
google.cloud.workstations_v1.types.workstations.ListWorkstationsResponse
],
],
request: google.cloud.workstations_v1.types.workstations.ListWorkstationsRequest,
response: google.cloud.workstations_v1.types.workstations.ListWorkstationsResponse,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiates the pager.
See more: google.cloud.workstations_v1.services.workstations.pagers.ListWorkstationsAsyncPager
google.cloud.workstations_v1.services.workstations.pagers.ListWorkstationsPager
ListWorkstationsPager(
method: typing.Callable[
[...], google.cloud.workstations_v1.types.workstations.ListWorkstationsResponse
],
request: google.cloud.workstations_v1.types.workstations.ListWorkstationsRequest,
response: google.cloud.workstations_v1.types.workstations.ListWorkstationsResponse,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiate the pager.
See more: google.cloud.workstations_v1.services.workstations.pagers.ListWorkstationsPager
google.cloud.workstations_v1beta.services.workstations.WorkstationsAsyncClient
WorkstationsAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.workstations_v1beta.services.workstations.transports.base.WorkstationsTransport, typing.Callable[[...], google.cloud.workstations_v1beta.services.workstations.transports.base.WorkstationsTransport]]] = 'grpc_asyncio', client_options: typing.Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo =
Instantiates the workstations async client.
See more: google.cloud.workstations_v1beta.services.workstations.WorkstationsAsyncClient
google.cloud.workstations_v1beta.services.workstations.WorkstationsAsyncClient.cancel_operation
cancel_operation(
request: typing.Optional[
google.longrunning.operations_pb2.CancelOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Starts asynchronous cancellation on a long-running operation.
See more: google.cloud.workstations_v1beta.services.workstations.WorkstationsAsyncClient.cancel_operation
google.cloud.workstations_v1beta.services.workstations.WorkstationsAsyncClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
google.cloud.workstations_v1beta.services.workstations.WorkstationsAsyncClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
See more: google.cloud.workstations_v1beta.services.workstations.WorkstationsAsyncClient.common_folder_path
google.cloud.workstations_v1beta.services.workstations.WorkstationsAsyncClient.common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
See more: google.cloud.workstations_v1beta.services.workstations.WorkstationsAsyncClient.common_location_path
google.cloud.workstations_v1beta.services.workstations.WorkstationsAsyncClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
google.cloud.workstations_v1beta.services.workstations.WorkstationsAsyncClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
See more: google.cloud.workstations_v1beta.services.workstations.WorkstationsAsyncClient.common_project_path
google.cloud.workstations_v1beta.services.workstations.WorkstationsAsyncClient.create_workstation
create_workstation(
request: typing.Optional[
typing.Union[
google.cloud.workstations_v1beta.types.workstations.CreateWorkstationRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
workstation: typing.Optional[
google.cloud.workstations_v1beta.types.workstations.Workstation
] = None,
workstation_id: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Creates a new workstation.
See more: google.cloud.workstations_v1beta.services.workstations.WorkstationsAsyncClient.create_workstation
google.cloud.workstations_v1beta.services.workstations.WorkstationsAsyncClient.create_workstation_cluster
create_workstation_cluster(
request: typing.Optional[
typing.Union[
google.cloud.workstations_v1beta.types.workstations.CreateWorkstationClusterRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
workstation_cluster: typing.Optional[
google.cloud.workstations_v1beta.types.workstations.WorkstationCluster
] = None,
workstation_cluster_id: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Creates a new workstation cluster.
google.cloud.workstations_v1beta.services.workstations.WorkstationsAsyncClient.create_workstation_config
create_workstation_config(
request: typing.Optional[
typing.Union[
google.cloud.workstations_v1beta.types.workstations.CreateWorkstationConfigRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
workstation_config: typing.Optional[
google.cloud.workstations_v1beta.types.workstations.WorkstationConfig
] = None,
workstation_config_id: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Creates a new workstation configuration.
google.cloud.workstations_v1beta.services.workstations.WorkstationsAsyncClient.delete_operation
delete_operation(
request: typing.Optional[
google.longrunning.operations_pb2.DeleteOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Deletes a long-running operation.
See more: google.cloud.workstations_v1beta.services.workstations.WorkstationsAsyncClient.delete_operation
google.cloud.workstations_v1beta.services.workstations.WorkstationsAsyncClient.delete_workstation
delete_workstation(
request: typing.Optional[
typing.Union[
google.cloud.workstations_v1beta.types.workstations.DeleteWorkstationRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Deletes the specified workstation.
See more: google.cloud.workstations_v1beta.services.workstations.WorkstationsAsyncClient.delete_workstation
google.cloud.workstations_v1beta.services.workstations.WorkstationsAsyncClient.delete_workstation_cluster
delete_workstation_cluster(
request: typing.Optional[
typing.Union[
google.cloud.workstations_v1beta.types.workstations.DeleteWorkstationClusterRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Deletes the specified workstation cluster.
google.cloud.workstations_v1beta.services.workstations.WorkstationsAsyncClient.delete_workstation_config
delete_workstation_config(
request: typing.Optional[
typing.Union[
google.cloud.workstations_v1beta.types.workstations.DeleteWorkstationConfigRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Deletes the specified workstation configuration.
google.cloud.workstations_v1beta.services.workstations.WorkstationsAsyncClient.from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.workstations_v1beta.services.workstations.WorkstationsAsyncClient.from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)
Creates an instance of this client using the provided credentials info.
google.cloud.workstations_v1beta.services.workstations.WorkstationsAsyncClient.from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.workstations_v1beta.services.workstations.WorkstationsAsyncClient.generate_access_token
generate_access_token(
request: typing.Optional[
typing.Union[
google.cloud.workstations_v1beta.types.workstations.GenerateAccessTokenRequest,
dict,
]
] = None,
*,
workstation: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.workstations_v1beta.types.workstations.GenerateAccessTokenResponse
Returns a short-lived credential that can be used to send authenticated and authorized traffic to a workstation.
See more: google.cloud.workstations_v1beta.services.workstations.WorkstationsAsyncClient.generate_access_token
google.cloud.workstations_v1beta.services.workstations.WorkstationsAsyncClient.get_iam_policy
get_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Gets the IAM access control policy for a function.
See more: google.cloud.workstations_v1beta.services.workstations.WorkstationsAsyncClient.get_iam_policy
google.cloud.workstations_v1beta.services.workstations.WorkstationsAsyncClient.get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: typing.Optional[
google.api_core.client_options.ClientOptions
] = None,
)
Return the API endpoint and client cert source for mutual TLS.
google.cloud.workstations_v1beta.services.workstations.WorkstationsAsyncClient.get_operation
get_operation(
request: typing.Optional[
google.longrunning.operations_pb2.GetOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Gets the latest state of a long-running operation.
See more: google.cloud.workstations_v1beta.services.workstations.WorkstationsAsyncClient.get_operation
google.cloud.workstations_v1beta.services.workstations.WorkstationsAsyncClient.get_transport_class
get_transport_class(
label: typing.Optional[str] = None,
) -> typing.Type[
google.cloud.workstations_v1beta.services.workstations.transports.base.WorkstationsTransport
]
Returns an appropriate transport class.
See more: google.cloud.workstations_v1beta.services.workstations.WorkstationsAsyncClient.get_transport_class
google.cloud.workstations_v1beta.services.workstations.WorkstationsAsyncClient.get_workstation
get_workstation(
request: typing.Optional[
typing.Union[
google.cloud.workstations_v1beta.types.workstations.GetWorkstationRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.workstations_v1beta.types.workstations.Workstation
Returns the requested workstation.
See more: google.cloud.workstations_v1beta.services.workstations.WorkstationsAsyncClient.get_workstation
google.cloud.workstations_v1beta.services.workstations.WorkstationsAsyncClient.get_workstation_cluster
get_workstation_cluster(
request: typing.Optional[
typing.Union[
google.cloud.workstations_v1beta.types.workstations.GetWorkstationClusterRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.workstations_v1beta.types.workstations.WorkstationCluster
Returns the requested workstation cluster.
google.cloud.workstations_v1beta.services.workstations.WorkstationsAsyncClient.get_workstation_config
get_workstation_config(
request: typing.Optional[
typing.Union[
google.cloud.workstations_v1beta.types.workstations.GetWorkstationConfigRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.workstations_v1beta.types.workstations.WorkstationConfig
Returns the requested workstation configuration.
google.cloud.workstations_v1beta.services.workstations.WorkstationsAsyncClient.list_operations
list_operations(
request: typing.Optional[
google.longrunning.operations_pb2.ListOperationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse
Lists operations that match the specified filter in the request.
See more: google.cloud.workstations_v1beta.services.workstations.WorkstationsAsyncClient.list_operations
google.cloud.workstations_v1beta.services.workstations.WorkstationsAsyncClient.list_usable_workstation_configs
list_usable_workstation_configs(
request: typing.Optional[
typing.Union[
google.cloud.workstations_v1beta.types.workstations.ListUsableWorkstationConfigsRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.workstations_v1beta.services.workstations.pagers.ListUsableWorkstationConfigsAsyncPager
)
Returns all workstation configurations in the specified cluster on which the caller has the "workstations.workstation.create" permission.
google.cloud.workstations_v1beta.services.workstations.WorkstationsAsyncClient.list_usable_workstations
list_usable_workstations(
request: typing.Optional[
typing.Union[
google.cloud.workstations_v1beta.types.workstations.ListUsableWorkstationsRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.workstations_v1beta.services.workstations.pagers.ListUsableWorkstationsAsyncPager
)
Returns all workstations using the specified workstation configuration on which the caller has the "workstations.workstations.use" permission.
google.cloud.workstations_v1beta.services.workstations.WorkstationsAsyncClient.list_workstation_clusters
list_workstation_clusters(
request: typing.Optional[
typing.Union[
google.cloud.workstations_v1beta.types.workstations.ListWorkstationClustersRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.workstations_v1beta.services.workstations.pagers.ListWorkstationClustersAsyncPager
)
Returns all workstation clusters in the specified location.
google.cloud.workstations_v1beta.services.workstations.WorkstationsAsyncClient.list_workstation_configs
list_workstation_configs(
request: typing.Optional[
typing.Union[
google.cloud.workstations_v1beta.types.workstations.ListWorkstationConfigsRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.workstations_v1beta.services.workstations.pagers.ListWorkstationConfigsAsyncPager
)
Returns all workstation configurations in the specified cluster.
google.cloud.workstations_v1beta.services.workstations.WorkstationsAsyncClient.list_workstations
list_workstations(
request: typing.Optional[
typing.Union[
google.cloud.workstations_v1beta.types.workstations.ListWorkstationsRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.workstations_v1beta.services.workstations.pagers.ListWorkstationsAsyncPager
)
Returns all Workstations using the specified workstation configuration.
See more: google.cloud.workstations_v1beta.services.workstations.WorkstationsAsyncClient.list_workstations
google.cloud.workstations_v1beta.services.workstations.WorkstationsAsyncClient.parse_common_billing_account_path
parse_common_billing_account_path(path: str) -> typing.Dict[str, str]
Parse a billing_account path into its component segments.
google.cloud.workstations_v1beta.services.workstations.WorkstationsAsyncClient.parse_common_folder_path
parse_common_folder_path(path: str) -> typing.Dict[str, str]
Parse a folder path into its component segments.
google.cloud.workstations_v1beta.services.workstations.WorkstationsAsyncClient.parse_common_location_path
parse_common_location_path(path: str) -> typing.Dict[str, str]
Parse a location path into its component segments.
google.cloud.workstations_v1beta.services.workstations.WorkstationsAsyncClient.parse_common_organization_path
parse_common_organization_path(path: str) -> typing.Dict[str, str]
Parse a organization path into its component segments.
google.cloud.workstations_v1beta.services.workstations.WorkstationsAsyncClient.parse_common_project_path
parse_common_project_path(path: str) -> typing.Dict[str, str]
Parse a project path into its component segments.
google.cloud.workstations_v1beta.services.workstations.WorkstationsAsyncClient.parse_workstation_cluster_path
parse_workstation_cluster_path(path: str) -> typing.Dict[str, str]
Parses a workstation_cluster path into its component segments.
google.cloud.workstations_v1beta.services.workstations.WorkstationsAsyncClient.parse_workstation_config_path
parse_workstation_config_path(path: str) -> typing.Dict[str, str]
Parses a workstation_config path into its component segments.
google.cloud.workstations_v1beta.services.workstations.WorkstationsAsyncClient.parse_workstation_path
parse_workstation_path(path: str) -> typing.Dict[str, str]
Parses a workstation path into its component segments.
google.cloud.workstations_v1beta.services.workstations.WorkstationsAsyncClient.set_iam_policy
set_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Sets the IAM access control policy on the specified function.
See more: google.cloud.workstations_v1beta.services.workstations.WorkstationsAsyncClient.set_iam_policy
google.cloud.workstations_v1beta.services.workstations.WorkstationsAsyncClient.start_workstation
start_workstation(
request: typing.Optional[
typing.Union[
google.cloud.workstations_v1beta.types.workstations.StartWorkstationRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Starts running a workstation so that users can connect to it.
See more: google.cloud.workstations_v1beta.services.workstations.WorkstationsAsyncClient.start_workstation
google.cloud.workstations_v1beta.services.workstations.WorkstationsAsyncClient.stop_workstation
stop_workstation(
request: typing.Optional[
typing.Union[
google.cloud.workstations_v1beta.types.workstations.StopWorkstationRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Stops running a workstation, reducing costs.
See more: google.cloud.workstations_v1beta.services.workstations.WorkstationsAsyncClient.stop_workstation
google.cloud.workstations_v1beta.services.workstations.WorkstationsAsyncClient.test_iam_permissions
test_iam_permissions(
request: typing.Optional[
google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.iam_policy_pb2.TestIamPermissionsResponse
Tests the specified IAM permissions against the IAM access control policy for a function.
See more: google.cloud.workstations_v1beta.services.workstations.WorkstationsAsyncClient.test_iam_permissions
google.cloud.workstations_v1beta.services.workstations.WorkstationsAsyncClient.update_workstation
update_workstation(
request: typing.Optional[
typing.Union[
google.cloud.workstations_v1beta.types.workstations.UpdateWorkstationRequest,
dict,
]
] = None,
*,
workstation: typing.Optional[
google.cloud.workstations_v1beta.types.workstations.Workstation
] = None,
update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Updates an existing workstation.
See more: google.cloud.workstations_v1beta.services.workstations.WorkstationsAsyncClient.update_workstation
google.cloud.workstations_v1beta.services.workstations.WorkstationsAsyncClient.update_workstation_cluster
update_workstation_cluster(
request: typing.Optional[
typing.Union[
google.cloud.workstations_v1beta.types.workstations.UpdateWorkstationClusterRequest,
dict,
]
] = None,
*,
workstation_cluster: typing.Optional[
google.cloud.workstations_v1beta.types.workstations.WorkstationCluster
] = None,
update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Updates an existing workstation cluster.
google.cloud.workstations_v1beta.services.workstations.WorkstationsAsyncClient.update_workstation_config
update_workstation_config(
request: typing.Optional[
typing.Union[
google.cloud.workstations_v1beta.types.workstations.UpdateWorkstationConfigRequest,
dict,
]
] = None,
*,
workstation_config: typing.Optional[
google.cloud.workstations_v1beta.types.workstations.WorkstationConfig
] = None,
update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Updates an existing workstation configuration.
google.cloud.workstations_v1beta.services.workstations.WorkstationsAsyncClient.workstation_cluster_path
workstation_cluster_path(
project: str, location: str, workstation_cluster: str
) -> str
Returns a fully-qualified workstation_cluster string.
google.cloud.workstations_v1beta.services.workstations.WorkstationsAsyncClient.workstation_config_path
workstation_config_path(
project: str, location: str, workstation_cluster: str, workstation_config: str
) -> str
Returns a fully-qualified workstation_config string.
google.cloud.workstations_v1beta.services.workstations.WorkstationsAsyncClient.workstation_path
workstation_path(
project: str,
location: str,
workstation_cluster: str,
workstation_config: str,
workstation: str,
) -> str
Returns a fully-qualified workstation string.
See more: google.cloud.workstations_v1beta.services.workstations.WorkstationsAsyncClient.workstation_path
google.cloud.workstations_v1beta.services.workstations.WorkstationsClient
WorkstationsClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.workstations_v1beta.services.workstations.transports.base.WorkstationsTransport, typing.Callable[[...], google.cloud.workstations_v1beta.services.workstations.transports.base.WorkstationsTransport]]] = None, client_options: typing.Optional[typing.Union[google.api_core.client_options.ClientOptions, dict]] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo =
Instantiates the workstations client.
See more: google.cloud.workstations_v1beta.services.workstations.WorkstationsClient
google.cloud.workstations_v1beta.services.workstations.WorkstationsClient.__exit__
__exit__(type, value, traceback)
Releases underlying transport's resources.
See more: google.cloud.workstations_v1beta.services.workstations.WorkstationsClient.exit
google.cloud.workstations_v1beta.services.workstations.WorkstationsClient.cancel_operation
cancel_operation(
request: typing.Optional[
google.longrunning.operations_pb2.CancelOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Starts asynchronous cancellation on a long-running operation.
See more: google.cloud.workstations_v1beta.services.workstations.WorkstationsClient.cancel_operation
google.cloud.workstations_v1beta.services.workstations.WorkstationsClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
google.cloud.workstations_v1beta.services.workstations.WorkstationsClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
See more: google.cloud.workstations_v1beta.services.workstations.WorkstationsClient.common_folder_path
google.cloud.workstations_v1beta.services.workstations.WorkstationsClient.common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
See more: google.cloud.workstations_v1beta.services.workstations.WorkstationsClient.common_location_path
google.cloud.workstations_v1beta.services.workstations.WorkstationsClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
See more: google.cloud.workstations_v1beta.services.workstations.WorkstationsClient.common_organization_path
google.cloud.workstations_v1beta.services.workstations.WorkstationsClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
See more: google.cloud.workstations_v1beta.services.workstations.WorkstationsClient.common_project_path
google.cloud.workstations_v1beta.services.workstations.WorkstationsClient.create_workstation
create_workstation(
request: typing.Optional[
typing.Union[
google.cloud.workstations_v1beta.types.workstations.CreateWorkstationRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
workstation: typing.Optional[
google.cloud.workstations_v1beta.types.workstations.Workstation
] = None,
workstation_id: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Creates a new workstation.
See more: google.cloud.workstations_v1beta.services.workstations.WorkstationsClient.create_workstation
google.cloud.workstations_v1beta.services.workstations.WorkstationsClient.create_workstation_cluster
create_workstation_cluster(
request: typing.Optional[
typing.Union[
google.cloud.workstations_v1beta.types.workstations.CreateWorkstationClusterRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
workstation_cluster: typing.Optional[
google.cloud.workstations_v1beta.types.workstations.WorkstationCluster
] = None,
workstation_cluster_id: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Creates a new workstation cluster.
See more: google.cloud.workstations_v1beta.services.workstations.WorkstationsClient.create_workstation_cluster
google.cloud.workstations_v1beta.services.workstations.WorkstationsClient.create_workstation_config
create_workstation_config(
request: typing.Optional[
typing.Union[
google.cloud.workstations_v1beta.types.workstations.CreateWorkstationConfigRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
workstation_config: typing.Optional[
google.cloud.workstations_v1beta.types.workstations.WorkstationConfig
] = None,
workstation_config_id: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Creates a new workstation configuration.
See more: google.cloud.workstations_v1beta.services.workstations.WorkstationsClient.create_workstation_config
google.cloud.workstations_v1beta.services.workstations.WorkstationsClient.delete_operation
delete_operation(
request: typing.Optional[
google.longrunning.operations_pb2.DeleteOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Deletes a long-running operation.
See more: google.cloud.workstations_v1beta.services.workstations.WorkstationsClient.delete_operation
google.cloud.workstations_v1beta.services.workstations.WorkstationsClient.delete_workstation
delete_workstation(
request: typing.Optional[
typing.Union[
google.cloud.workstations_v1beta.types.workstations.DeleteWorkstationRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Deletes the specified workstation.
See more: google.cloud.workstations_v1beta.services.workstations.WorkstationsClient.delete_workstation
google.cloud.workstations_v1beta.services.workstations.WorkstationsClient.delete_workstation_cluster
delete_workstation_cluster(
request: typing.Optional[
typing.Union[
google.cloud.workstations_v1beta.types.workstations.DeleteWorkstationClusterRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Deletes the specified workstation cluster.
See more: google.cloud.workstations_v1beta.services.workstations.WorkstationsClient.delete_workstation_cluster
google.cloud.workstations_v1beta.services.workstations.WorkstationsClient.delete_workstation_config
delete_workstation_config(
request: typing.Optional[
typing.Union[
google.cloud.workstations_v1beta.types.workstations.DeleteWorkstationConfigRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Deletes the specified workstation configuration.
See more: google.cloud.workstations_v1beta.services.workstations.WorkstationsClient.delete_workstation_config
google.cloud.workstations_v1beta.services.workstations.WorkstationsClient.from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
See more: google.cloud.workstations_v1beta.services.workstations.WorkstationsClient.from_service_account_file
google.cloud.workstations_v1beta.services.workstations.WorkstationsClient.from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)
Creates an instance of this client using the provided credentials info.
See more: google.cloud.workstations_v1beta.services.workstations.WorkstationsClient.from_service_account_info
google.cloud.workstations_v1beta.services.workstations.WorkstationsClient.from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
See more: google.cloud.workstations_v1beta.services.workstations.WorkstationsClient.from_service_account_json
google.cloud.workstations_v1beta.services.workstations.WorkstationsClient.generate_access_token
generate_access_token(
request: typing.Optional[
typing.Union[
google.cloud.workstations_v1beta.types.workstations.GenerateAccessTokenRequest,
dict,
]
] = None,
*,
workstation: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.workstations_v1beta.types.workstations.GenerateAccessTokenResponse
Returns a short-lived credential that can be used to send authenticated and authorized traffic to a workstation.
See more: google.cloud.workstations_v1beta.services.workstations.WorkstationsClient.generate_access_token
google.cloud.workstations_v1beta.services.workstations.WorkstationsClient.get_iam_policy
get_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Gets the IAM access control policy for a function.
See more: google.cloud.workstations_v1beta.services.workstations.WorkstationsClient.get_iam_policy
google.cloud.workstations_v1beta.services.workstations.WorkstationsClient.get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: typing.Optional[
google.api_core.client_options.ClientOptions
] = None,
)
Deprecated.
google.cloud.workstations_v1beta.services.workstations.WorkstationsClient.get_operation
get_operation(
request: typing.Optional[
google.longrunning.operations_pb2.GetOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Gets the latest state of a long-running operation.
See more: google.cloud.workstations_v1beta.services.workstations.WorkstationsClient.get_operation
google.cloud.workstations_v1beta.services.workstations.WorkstationsClient.get_workstation
get_workstation(
request: typing.Optional[
typing.Union[
google.cloud.workstations_v1beta.types.workstations.GetWorkstationRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.workstations_v1beta.types.workstations.Workstation
Returns the requested workstation.
See more: google.cloud.workstations_v1beta.services.workstations.WorkstationsClient.get_workstation
google.cloud.workstations_v1beta.services.workstations.WorkstationsClient.get_workstation_cluster
get_workstation_cluster(
request: typing.Optional[
typing.Union[
google.cloud.workstations_v1beta.types.workstations.GetWorkstationClusterRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.workstations_v1beta.types.workstations.WorkstationCluster
Returns the requested workstation cluster.
See more: google.cloud.workstations_v1beta.services.workstations.WorkstationsClient.get_workstation_cluster
google.cloud.workstations_v1beta.services.workstations.WorkstationsClient.get_workstation_config
get_workstation_config(
request: typing.Optional[
typing.Union[
google.cloud.workstations_v1beta.types.workstations.GetWorkstationConfigRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.workstations_v1beta.types.workstations.WorkstationConfig
Returns the requested workstation configuration.
See more: google.cloud.workstations_v1beta.services.workstations.WorkstationsClient.get_workstation_config
google.cloud.workstations_v1beta.services.workstations.WorkstationsClient.list_operations
list_operations(
request: typing.Optional[
google.longrunning.operations_pb2.ListOperationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse
Lists operations that match the specified filter in the request.
See more: google.cloud.workstations_v1beta.services.workstations.WorkstationsClient.list_operations
google.cloud.workstations_v1beta.services.workstations.WorkstationsClient.list_usable_workstation_configs
list_usable_workstation_configs(
request: typing.Optional[
typing.Union[
google.cloud.workstations_v1beta.types.workstations.ListUsableWorkstationConfigsRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.workstations_v1beta.services.workstations.pagers.ListUsableWorkstationConfigsPager
)
Returns all workstation configurations in the specified cluster on which the caller has the "workstations.workstation.create" permission.
google.cloud.workstations_v1beta.services.workstations.WorkstationsClient.list_usable_workstations
list_usable_workstations(
request: typing.Optional[
typing.Union[
google.cloud.workstations_v1beta.types.workstations.ListUsableWorkstationsRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.workstations_v1beta.services.workstations.pagers.ListUsableWorkstationsPager
)
Returns all workstations using the specified workstation configuration on which the caller has the "workstations.workstations.use" permission.
See more: google.cloud.workstations_v1beta.services.workstations.WorkstationsClient.list_usable_workstations
google.cloud.workstations_v1beta.services.workstations.WorkstationsClient.list_workstation_clusters
list_workstation_clusters(
request: typing.Optional[
typing.Union[
google.cloud.workstations_v1beta.types.workstations.ListWorkstationClustersRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.workstations_v1beta.services.workstations.pagers.ListWorkstationClustersPager
)
Returns all workstation clusters in the specified location.
See more: google.cloud.workstations_v1beta.services.workstations.WorkstationsClient.list_workstation_clusters
google.cloud.workstations_v1beta.services.workstations.WorkstationsClient.list_workstation_configs
list_workstation_configs(
request: typing.Optional[
typing.Union[
google.cloud.workstations_v1beta.types.workstations.ListWorkstationConfigsRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.workstations_v1beta.services.workstations.pagers.ListWorkstationConfigsPager
)
Returns all workstation configurations in the specified cluster.
See more: google.cloud.workstations_v1beta.services.workstations.WorkstationsClient.list_workstation_configs
google.cloud.workstations_v1beta.services.workstations.WorkstationsClient.list_workstations
list_workstations(
request: typing.Optional[
typing.Union[
google.cloud.workstations_v1beta.types.workstations.ListWorkstationsRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.workstations_v1beta.services.workstations.pagers.ListWorkstationsPager
)
Returns all Workstations using the specified workstation configuration.
See more: google.cloud.workstations_v1beta.services.workstations.WorkstationsClient.list_workstations
google.cloud.workstations_v1beta.services.workstations.WorkstationsClient.parse_common_billing_account_path
parse_common_billing_account_path(path: str) -> typing.Dict[str, str]
Parse a billing_account path into its component segments.
google.cloud.workstations_v1beta.services.workstations.WorkstationsClient.parse_common_folder_path
parse_common_folder_path(path: str) -> typing.Dict[str, str]
Parse a folder path into its component segments.
See more: google.cloud.workstations_v1beta.services.workstations.WorkstationsClient.parse_common_folder_path
google.cloud.workstations_v1beta.services.workstations.WorkstationsClient.parse_common_location_path
parse_common_location_path(path: str) -> typing.Dict[str, str]
Parse a location path into its component segments.
See more: google.cloud.workstations_v1beta.services.workstations.WorkstationsClient.parse_common_location_path
google.cloud.workstations_v1beta.services.workstations.WorkstationsClient.parse_common_organization_path
parse_common_organization_path(path: str) -> typing.Dict[str, str]
Parse a organization path into its component segments.
google.cloud.workstations_v1beta.services.workstations.WorkstationsClient.parse_common_project_path
parse_common_project_path(path: str) -> typing.Dict[str, str]
Parse a project path into its component segments.
See more: google.cloud.workstations_v1beta.services.workstations.WorkstationsClient.parse_common_project_path
google.cloud.workstations_v1beta.services.workstations.WorkstationsClient.parse_workstation_cluster_path
parse_workstation_cluster_path(path: str) -> typing.Dict[str, str]
Parses a workstation_cluster path into its component segments.
google.cloud.workstations_v1beta.services.workstations.WorkstationsClient.parse_workstation_config_path
parse_workstation_config_path(path: str) -> typing.Dict[str, str]
Parses a workstation_config path into its component segments.
google.cloud.workstations_v1beta.services.workstations.WorkstationsClient.parse_workstation_path
parse_workstation_path(path: str) -> typing.Dict[str, str]
Parses a workstation path into its component segments.
See more: google.cloud.workstations_v1beta.services.workstations.WorkstationsClient.parse_workstation_path
google.cloud.workstations_v1beta.services.workstations.WorkstationsClient.set_iam_policy
set_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Sets the IAM access control policy on the specified function.
See more: google.cloud.workstations_v1beta.services.workstations.WorkstationsClient.set_iam_policy
google.cloud.workstations_v1beta.services.workstations.WorkstationsClient.start_workstation
start_workstation(
request: typing.Optional[
typing.Union[
google.cloud.workstations_v1beta.types.workstations.StartWorkstationRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Starts running a workstation so that users can connect to it.
See more: google.cloud.workstations_v1beta.services.workstations.WorkstationsClient.start_workstation
google.cloud.workstations_v1beta.services.workstations.WorkstationsClient.stop_workstation
stop_workstation(
request: typing.Optional[
typing.Union[
google.cloud.workstations_v1beta.types.workstations.StopWorkstationRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Stops running a workstation, reducing costs.
See more: google.cloud.workstations_v1beta.services.workstations.WorkstationsClient.stop_workstation
google.cloud.workstations_v1beta.services.workstations.WorkstationsClient.test_iam_permissions
test_iam_permissions(
request: typing.Optional[
google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.iam_policy_pb2.TestIamPermissionsResponse
Tests the specified IAM permissions against the IAM access control policy for a function.
See more: google.cloud.workstations_v1beta.services.workstations.WorkstationsClient.test_iam_permissions
google.cloud.workstations_v1beta.services.workstations.WorkstationsClient.update_workstation
update_workstation(
request: typing.Optional[
typing.Union[
google.cloud.workstations_v1beta.types.workstations.UpdateWorkstationRequest,
dict,
]
] = None,
*,
workstation: typing.Optional[
google.cloud.workstations_v1beta.types.workstations.Workstation
] = None,
update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Updates an existing workstation.
See more: google.cloud.workstations_v1beta.services.workstations.WorkstationsClient.update_workstation
google.cloud.workstations_v1beta.services.workstations.WorkstationsClient.update_workstation_cluster
update_workstation_cluster(
request: typing.Optional[
typing.Union[
google.cloud.workstations_v1beta.types.workstations.UpdateWorkstationClusterRequest,
dict,
]
] = None,
*,
workstation_cluster: typing.Optional[
google.cloud.workstations_v1beta.types.workstations.WorkstationCluster
] = None,
update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Updates an existing workstation cluster.
See more: google.cloud.workstations_v1beta.services.workstations.WorkstationsClient.update_workstation_cluster
google.cloud.workstations_v1beta.services.workstations.WorkstationsClient.update_workstation_config
update_workstation_config(
request: typing.Optional[
typing.Union[
google.cloud.workstations_v1beta.types.workstations.UpdateWorkstationConfigRequest,
dict,
]
] = None,
*,
workstation_config: typing.Optional[
google.cloud.workstations_v1beta.types.workstations.WorkstationConfig
] = None,
update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Updates an existing workstation configuration.
See more: google.cloud.workstations_v1beta.services.workstations.WorkstationsClient.update_workstation_config
google.cloud.workstations_v1beta.services.workstations.WorkstationsClient.workstation_cluster_path
workstation_cluster_path(
project: str, location: str, workstation_cluster: str
) -> str
Returns a fully-qualified workstation_cluster string.
See more: google.cloud.workstations_v1beta.services.workstations.WorkstationsClient.workstation_cluster_path
google.cloud.workstations_v1beta.services.workstations.WorkstationsClient.workstation_config_path
workstation_config_path(
project: str, location: str, workstation_cluster: str, workstation_config: str
) -> str
Returns a fully-qualified workstation_config string.
See more: google.cloud.workstations_v1beta.services.workstations.WorkstationsClient.workstation_config_path
google.cloud.workstations_v1beta.services.workstations.WorkstationsClient.workstation_path
workstation_path(
project: str,
location: str,
workstation_cluster: str,
workstation_config: str,
workstation: str,
) -> str
Returns a fully-qualified workstation string.
See more: google.cloud.workstations_v1beta.services.workstations.WorkstationsClient.workstation_path
google.cloud.workstations_v1beta.services.workstations.pagers.ListUsableWorkstationConfigsAsyncPager
ListUsableWorkstationConfigsAsyncPager(
method: typing.Callable[
[...],
typing.Awaitable[
google.cloud.workstations_v1beta.types.workstations.ListUsableWorkstationConfigsResponse
],
],
request: google.cloud.workstations_v1beta.types.workstations.ListUsableWorkstationConfigsRequest,
response: google.cloud.workstations_v1beta.types.workstations.ListUsableWorkstationConfigsResponse,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiates the pager.
See more: google.cloud.workstations_v1beta.services.workstations.pagers.ListUsableWorkstationConfigsAsyncPager
google.cloud.workstations_v1beta.services.workstations.pagers.ListUsableWorkstationConfigsPager
ListUsableWorkstationConfigsPager(
method: typing.Callable[
[...],
google.cloud.workstations_v1beta.types.workstations.ListUsableWorkstationConfigsResponse,
],
request: google.cloud.workstations_v1beta.types.workstations.ListUsableWorkstationConfigsRequest,
response: google.cloud.workstations_v1beta.types.workstations.ListUsableWorkstationConfigsResponse,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiate the pager.
See more: google.cloud.workstations_v1beta.services.workstations.pagers.ListUsableWorkstationConfigsPager
google.cloud.workstations_v1beta.services.workstations.pagers.ListUsableWorkstationsAsyncPager
ListUsableWorkstationsAsyncPager(
method: typing.Callable[
[...],
typing.Awaitable[
google.cloud.workstations_v1beta.types.workstations.ListUsableWorkstationsResponse
],
],
request: google.cloud.workstations_v1beta.types.workstations.ListUsableWorkstationsRequest,
response: google.cloud.workstations_v1beta.types.workstations.ListUsableWorkstationsResponse,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiates the pager.
See more: google.cloud.workstations_v1beta.services.workstations.pagers.ListUsableWorkstationsAsyncPager
google.cloud.workstations_v1beta.services.workstations.pagers.ListUsableWorkstationsPager
ListUsableWorkstationsPager(
method: typing.Callable[
[...],
google.cloud.workstations_v1beta.types.workstations.ListUsableWorkstationsResponse,
],
request: google.cloud.workstations_v1beta.types.workstations.ListUsableWorkstationsRequest,
response: google.cloud.workstations_v1beta.types.workstations.ListUsableWorkstationsResponse,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiate the pager.
See more: google.cloud.workstations_v1beta.services.workstations.pagers.ListUsableWorkstationsPager
google.cloud.workstations_v1beta.services.workstations.pagers.ListWorkstationClustersAsyncPager
ListWorkstationClustersAsyncPager(
method: typing.Callable[
[...],
typing.Awaitable[
google.cloud.workstations_v1beta.types.workstations.ListWorkstationClustersResponse
],
],
request: google.cloud.workstations_v1beta.types.workstations.ListWorkstationClustersRequest,
response: google.cloud.workstations_v1beta.types.workstations.ListWorkstationClustersResponse,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiates the pager.
See more: google.cloud.workstations_v1beta.services.workstations.pagers.ListWorkstationClustersAsyncPager
google.cloud.workstations_v1beta.services.workstations.pagers.ListWorkstationClustersPager
ListWorkstationClustersPager(
method: typing.Callable[
[...],
google.cloud.workstations_v1beta.types.workstations.ListWorkstationClustersResponse,
],
request: google.cloud.workstations_v1beta.types.workstations.ListWorkstationClustersRequest,
response: google.cloud.workstations_v1beta.types.workstations.ListWorkstationClustersResponse,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiate the pager.
See more: google.cloud.workstations_v1beta.services.workstations.pagers.ListWorkstationClustersPager
google.cloud.workstations_v1beta.services.workstations.pagers.ListWorkstationConfigsAsyncPager
ListWorkstationConfigsAsyncPager(
method: typing.Callable[
[...],
typing.Awaitable[
google.cloud.workstations_v1beta.types.workstations.ListWorkstationConfigsResponse
],
],
request: google.cloud.workstations_v1beta.types.workstations.ListWorkstationConfigsRequest,
response: google.cloud.workstations_v1beta.types.workstations.ListWorkstationConfigsResponse,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiates the pager.
See more: google.cloud.workstations_v1beta.services.workstations.pagers.ListWorkstationConfigsAsyncPager
google.cloud.workstations_v1beta.services.workstations.pagers.ListWorkstationConfigsPager
ListWorkstationConfigsPager(
method: typing.Callable[
[...],
google.cloud.workstations_v1beta.types.workstations.ListWorkstationConfigsResponse,
],
request: google.cloud.workstations_v1beta.types.workstations.ListWorkstationConfigsRequest,
response: google.cloud.workstations_v1beta.types.workstations.ListWorkstationConfigsResponse,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiate the pager.
See more: google.cloud.workstations_v1beta.services.workstations.pagers.ListWorkstationConfigsPager
google.cloud.workstations_v1beta.services.workstations.pagers.ListWorkstationsAsyncPager
ListWorkstationsAsyncPager(
method: typing.Callable[
[...],
typing.Awaitable[
google.cloud.workstations_v1beta.types.workstations.ListWorkstationsResponse
],
],
request: google.cloud.workstations_v1beta.types.workstations.ListWorkstationsRequest,
response: google.cloud.workstations_v1beta.types.workstations.ListWorkstationsResponse,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiates the pager.
See more: google.cloud.workstations_v1beta.services.workstations.pagers.ListWorkstationsAsyncPager
google.cloud.workstations_v1beta.services.workstations.pagers.ListWorkstationsPager
ListWorkstationsPager(
method: typing.Callable[
[...],
google.cloud.workstations_v1beta.types.workstations.ListWorkstationsResponse,
],
request: google.cloud.workstations_v1beta.types.workstations.ListWorkstationsRequest,
response: google.cloud.workstations_v1beta.types.workstations.ListWorkstationsResponse,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiate the pager.
See more: google.cloud.workstations_v1beta.services.workstations.pagers.ListWorkstationsPager