Class CloudShellServiceAsyncClient (1.5.0)
Stay organized with collections
Save and categorize content based on your preferences.
CloudShellServiceAsyncClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Union[str, google.cloud.shell_v1.services.cloud_shell_service.transports.base.CloudShellServiceTransport] = 'grpc_asyncio', client_options: Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)API for interacting with Google Cloud Shell. Each user of Cloud Shell has at least one environment, which has the ID "default". Environment consists of a Docker image defining what is installed on the environment and a home directory containing the user's data that will remain across sessions. Clients use this API to start and fetch information about their environment, which can then be used to connect to that environment via a separate SSH client.
Properties
transport
Returns the transport used by the client instance.
CloudShellServiceTransport
The transport used by the client instance.
Methods
CloudShellServiceAsyncClient
CloudShellServiceAsyncClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Union[str, google.cloud.shell_v1.services.cloud_shell_service.transports.base.CloudShellServiceTransport] = 'grpc_asyncio', client_options: Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)Instantiates the cloud shell service client.
credentials
Optional[google.auth.credentials.Credentials]
The authorization credentials to attach to requests. These credentials identify the application to the service; if none are specified, the client will attempt to ascertain the credentials from the environment.
transport
Union[str, .CloudShellServiceTransport]
The transport to use. If set to None, a transport is chosen automatically.
client_options
ClientOptions
Custom options for the client. It won't take effect if a transport instance is provided. (1) The api_endpoint property can be used to override the default endpoint provided by the client. GOOGLE_API_USE_MTLS_ENDPOINT environment variable can also be used to override the endpoint: "always" (always use the default mTLS endpoint), "never" (always use the default regular endpoint) and "auto" (auto switch to the default mTLS endpoint if client certificate is present, this is the default value). However, the api_endpoint property takes precedence if provided. (2) If GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is "true", then the client_cert_source property can be used to provide client certificate for mutual TLS transport. If not provided, the default SSL client certificate will be used if present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is "false" or not set, no client certificate will be used.
google.auth.exceptions.MutualTlsChannelError
If mutual TLS transport creation failed for any reason.
add_public_key
add_public_key(request: Optional[Union[google.cloud.shell_v1.types.cloudshell.AddPublicKeyRequest, dict]] = None, *, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ())Adds a public SSH key to an environment, allowing clients with the corresponding private key to connect to that environment via SSH. If a key with the same content already exists, this will error with ALREADY_EXISTS.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import shell_v1
async def sample_add_public_key():
# Create a client
client = shell_v1.CloudShellServiceAsyncClient()
# Initialize request argument(s)
request = shell_v1.AddPublicKeyRequest(
)
# Make the request
operation = client.add_public_key(request=request)
print("Waiting for operation to complete...")
response = (await operation).result()
# Handle the response
print(response)
request
Optional[Union[google.cloud.shell_v1.types.AddPublicKeyRequest, dict]]
The request object. Request message for AddPublicKey.
retry
google.api_core.retry.Retry
Designation of what errors, if any, should be retried.
timeout
float
The timeout for this request.
metadata
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata.
google.api_core.operation_async.AsyncOperation
An object representing a long-running operation. The result type for the operation will be AddPublicKeyResponse Response message for AddPublicKey.
authorize_environment
authorize_environment(request: Optional[Union[google.cloud.shell_v1.types.cloudshell.AuthorizeEnvironmentRequest, dict]] = None, *, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ())Sends OAuth credentials to a running environment on behalf of a user. When this completes, the environment will be authorized to run various Google Cloud command line tools without requiring the user to manually authenticate.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import shell_v1
async def sample_authorize_environment():
# Create a client
client = shell_v1.CloudShellServiceAsyncClient()
# Initialize request argument(s)
request = shell_v1.AuthorizeEnvironmentRequest(
)
# Make the request
operation = client.authorize_environment(request=request)
print("Waiting for operation to complete...")
response = (await operation).result()
# Handle the response
print(response)
request
Optional[Union[google.cloud.shell_v1.types.AuthorizeEnvironmentRequest, dict]]
The request object. Request message for AuthorizeEnvironment.
retry
google.api_core.retry.Retry
Designation of what errors, if any, should be retried.
timeout
float
The timeout for this request.
metadata
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata.
google.api_core.operation_async.AsyncOperation
An object representing a long-running operation. The result type for the operation will be AuthorizeEnvironmentResponse Response message for AuthorizeEnvironment.
common_billing_account_path
common_billing_account_path(billing_account: str)Returns a fully-qualified billing_account string.
common_folder_path
common_folder_path(folder: str)Returns a fully-qualified folder string.
common_location_path
common_location_path(project: str, location: str)Returns a fully-qualified location string.
common_organization_path
common_organization_path(organization: str)Returns a fully-qualified organization string.
common_project_path
common_project_path(project: str)Returns a fully-qualified project string.
environment_path
environment_path(user: str, environment: str)Returns a fully-qualified environment string.
from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)Creates an instance of this client using the provided credentials file.
filename
str
The path to the service account private key json file.
CloudShellServiceAsyncClient
The constructed client.
from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)Creates an instance of this client using the provided credentials info.
info
dict
The service account private key info.
CloudShellServiceAsyncClient
The constructed client.
from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)Creates an instance of this client using the provided credentials file.
filename
str
The path to the service account private key json file.
CloudShellServiceAsyncClient
The constructed client.
get_environment
get_environment(request: Optional[Union[google.cloud.shell_v1.types.cloudshell.GetEnvironmentRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ())Gets an environment. Returns NOT_FOUND if the environment does not exist.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import shell_v1
async def sample_get_environment():
# Create a client
client = shell_v1.CloudShellServiceAsyncClient()
# Initialize request argument(s)
request = shell_v1.GetEnvironmentRequest(
name="name_value",
)
# Make the request
response = await client.get_environment(request=request)
# Handle the response
print(response)
request
Optional[Union[google.cloud.shell_v1.types.GetEnvironmentRequest, dict]]
The request object. Request message for GetEnvironment.
name
strRequired. Name of the requested resource, for example users/me/environments/default or users/someone@example.com/environments/default. This corresponds to the name field on the request instance; if request is provided, this should not be set.
retry
google.api_core.retry.Retry
Designation of what errors, if any, should be retried.
timeout
float
The timeout for this request.
metadata
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata.
google.cloud.shell_v1.types.Environment
A Cloud Shell environment, which is defined as the combination of a Docker image specifying what is installed on the environment and a home directory containing the user's data that will remain across sessions. Each user has at least an environment with the ID "default".
get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: Optional[google.api_core.client_options.ClientOptions] = None,
)Return the API endpoint and client cert source for mutual TLS.
The client cert source is determined in the following order:
(1) if GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is not "true", the
client cert source is None.
(2) if client_options.client_cert_source is provided, use the provided one; if the
default client cert source exists, use the default one; otherwise the client cert
source is None.
The API endpoint is determined in the following order:
(1) if client_options.api_endpoint if provided, use the provided one.
(2) if GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is "always", use the
default mTLS endpoint; if the environment variabel is "never", use the default API
endpoint; otherwise if client cert source exists, use the default mTLS endpoint, otherwise
use the default API endpoint.
More details can be found at https://google.aip.dev/auth/4114.
client_options
google.api_core.client_options.ClientOptions
Custom options for the client. Only the api_endpoint and client_cert_source properties may be used in this method.
google.auth.exceptions.MutualTLSChannelError
If any errors happen.
Tuple[str, Callable[[], Tuple[bytes, bytes]]]
returns the API endpoint and the client cert source to use.
get_transport_class
get_transport_class()Returns an appropriate transport class.
parse_common_billing_account_path
parse_common_billing_account_path(path: str)Parse a billing_account path into its component segments.
parse_common_folder_path
parse_common_folder_path(path: str)Parse a folder path into its component segments.
parse_common_location_path
parse_common_location_path(path: str)Parse a location path into its component segments.
parse_common_organization_path
parse_common_organization_path(path: str)Parse a organization path into its component segments.
parse_common_project_path
parse_common_project_path(path: str)Parse a project path into its component segments.
parse_environment_path
parse_environment_path(path: str)Parses a environment path into its component segments.
remove_public_key
remove_public_key(request: Optional[Union[google.cloud.shell_v1.types.cloudshell.RemovePublicKeyRequest, dict]] = None, *, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ())Removes a public SSH key from an environment. Clients will no longer be able to connect to the environment using the corresponding private key. If a key with the same content is not present, this will error with NOT_FOUND.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import shell_v1
async def sample_remove_public_key():
# Create a client
client = shell_v1.CloudShellServiceAsyncClient()
# Initialize request argument(s)
request = shell_v1.RemovePublicKeyRequest(
)
# Make the request
operation = client.remove_public_key(request=request)
print("Waiting for operation to complete...")
response = (await operation).result()
# Handle the response
print(response)
request
Optional[Union[google.cloud.shell_v1.types.RemovePublicKeyRequest, dict]]
The request object. Request message for RemovePublicKey.
retry
google.api_core.retry.Retry
Designation of what errors, if any, should be retried.
timeout
float
The timeout for this request.
metadata
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata.
google.api_core.operation_async.AsyncOperation
An object representing a long-running operation. The result type for the operation will be RemovePublicKeyResponse Response message for RemovePublicKey.
start_environment
start_environment(request: Optional[Union[google.cloud.shell_v1.types.cloudshell.StartEnvironmentRequest, dict]] = None, *, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ())Starts an existing environment, allowing clients to connect to it. The returned operation will contain an instance of StartEnvironmentMetadata in its metadata field. Users can wait for the environment to start by polling this operation via GetOperation. Once the environment has finished starting and is ready to accept connections, the operation will contain a StartEnvironmentResponse in its response field.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import shell_v1
async def sample_start_environment():
# Create a client
client = shell_v1.CloudShellServiceAsyncClient()
# Initialize request argument(s)
request = shell_v1.StartEnvironmentRequest(
)
# Make the request
operation = client.start_environment(request=request)
print("Waiting for operation to complete...")
response = (await operation).result()
# Handle the response
print(response)
request
Optional[Union[google.cloud.shell_v1.types.StartEnvironmentRequest, dict]]
The request object. Request message for StartEnvironment.
retry
google.api_core.retry.Retry
Designation of what errors, if any, should be retried.
timeout
float
The timeout for this request.
metadata
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata.
google.api_core.operation_async.AsyncOperation
An object representing a long-running operation. The result type for the operation will be StartEnvironmentResponse Message included in the response field of operations returned from StartEnvironment once the operation is complete.