Package Methods (1.10.1)

Summary of entries of Methods for cloudshell.

google.cloud.shell_v1.services.cloud_shell_service.CloudShellServiceAsyncClient

CloudShellServiceAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.shell_v1.services.cloud_shell_service.transports.base.CloudShellServiceTransport, typing.Callable[[...], google.cloud.shell_v1.services.cloud_shell_service.transports.base.CloudShellServiceTransport]]] = '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 cloud shell service async client.

See more: google.cloud.shell_v1.services.cloud_shell_service.CloudShellServiceAsyncClient

google.cloud.shell_v1.services.cloud_shell_service.CloudShellServiceAsyncClient.add_public_key

add_public_key(
 request: typing.Optional[
 typing.Union[google.cloud.shell_v1.types.cloudshell.AddPublicKeyRequest, dict]
 ] = 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

Adds a public SSH key to an environment, allowing clients with the corresponding private key to connect to that environment via SSH.

See more: google.cloud.shell_v1.services.cloud_shell_service.CloudShellServiceAsyncClient.add_public_key

google.cloud.shell_v1.services.cloud_shell_service.CloudShellServiceAsyncClient.authorize_environment

authorize_environment(
 request: typing.Optional[
 typing.Union[
 google.cloud.shell_v1.types.cloudshell.AuthorizeEnvironmentRequest, dict
 ]
 ] = 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

Sends OAuth credentials to a running environment on behalf of a user.

See more: google.cloud.shell_v1.services.cloud_shell_service.CloudShellServiceAsyncClient.authorize_environment

google.cloud.shell_v1.services.cloud_shell_service.CloudShellServiceAsyncClient.common_billing_account_path

common_billing_account_path(billing_account: str) -> str

google.cloud.shell_v1.services.cloud_shell_service.CloudShellServiceAsyncClient.common_folder_path

common_folder_path(folder: str) -> str

google.cloud.shell_v1.services.cloud_shell_service.CloudShellServiceAsyncClient.common_location_path

common_location_path(project: str, location: str) -> str

google.cloud.shell_v1.services.cloud_shell_service.CloudShellServiceAsyncClient.common_organization_path

common_organization_path(organization: str) -> str

google.cloud.shell_v1.services.cloud_shell_service.CloudShellServiceAsyncClient.common_project_path

common_project_path(project: str) -> str

google.cloud.shell_v1.services.cloud_shell_service.CloudShellServiceAsyncClient.environment_path

environment_path(user: str, environment: str) -> str

google.cloud.shell_v1.services.cloud_shell_service.CloudShellServiceAsyncClient.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.shell_v1.services.cloud_shell_service.CloudShellServiceAsyncClient.from_service_account_file

google.cloud.shell_v1.services.cloud_shell_service.CloudShellServiceAsyncClient.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.shell_v1.services.cloud_shell_service.CloudShellServiceAsyncClient.from_service_account_info

google.cloud.shell_v1.services.cloud_shell_service.CloudShellServiceAsyncClient.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.shell_v1.services.cloud_shell_service.CloudShellServiceAsyncClient.from_service_account_json

google.cloud.shell_v1.services.cloud_shell_service.CloudShellServiceAsyncClient.get_environment

get_environment(
 request: typing.Optional[
 typing.Union[google.cloud.shell_v1.types.cloudshell.GetEnvironmentRequest, 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.shell_v1.types.cloudshell.Environment

google.cloud.shell_v1.services.cloud_shell_service.CloudShellServiceAsyncClient.get_mtls_endpoint_and_cert_source

get_mtls_endpoint_and_cert_source(
 client_options: typing.Optional[
 google.api_core.client_options.ClientOptions
 ] = None,
)

google.cloud.shell_v1.services.cloud_shell_service.CloudShellServiceAsyncClient.get_transport_class

get_transport_class(
 label: typing.Optional[str] = None,
) -> typing.Type[
 google.cloud.shell_v1.services.cloud_shell_service.transports.base.CloudShellServiceTransport
]

google.cloud.shell_v1.services.cloud_shell_service.CloudShellServiceAsyncClient.parse_common_billing_account_path

parse_common_billing_account_path(path: str) -> typing.Dict[str, str]

google.cloud.shell_v1.services.cloud_shell_service.CloudShellServiceAsyncClient.parse_common_folder_path

parse_common_folder_path(path: str) -> typing.Dict[str, str]

google.cloud.shell_v1.services.cloud_shell_service.CloudShellServiceAsyncClient.parse_common_location_path

parse_common_location_path(path: str) -> typing.Dict[str, str]

google.cloud.shell_v1.services.cloud_shell_service.CloudShellServiceAsyncClient.parse_common_organization_path

parse_common_organization_path(path: str) -> typing.Dict[str, str]

google.cloud.shell_v1.services.cloud_shell_service.CloudShellServiceAsyncClient.parse_common_project_path

parse_common_project_path(path: str) -> typing.Dict[str, str]

google.cloud.shell_v1.services.cloud_shell_service.CloudShellServiceAsyncClient.parse_environment_path

parse_environment_path(path: str) -> typing.Dict[str, str]

google.cloud.shell_v1.services.cloud_shell_service.CloudShellServiceAsyncClient.remove_public_key

remove_public_key(
 request: typing.Optional[
 typing.Union[
 google.cloud.shell_v1.types.cloudshell.RemovePublicKeyRequest, dict
 ]
 ] = 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

google.cloud.shell_v1.services.cloud_shell_service.CloudShellServiceAsyncClient.start_environment

start_environment(
 request: typing.Optional[
 typing.Union[
 google.cloud.shell_v1.types.cloudshell.StartEnvironmentRequest, dict
 ]
 ] = 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 an existing environment, allowing clients to connect to it.

See more: google.cloud.shell_v1.services.cloud_shell_service.CloudShellServiceAsyncClient.start_environment

google.cloud.shell_v1.services.cloud_shell_service.CloudShellServiceClient

CloudShellServiceClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.shell_v1.services.cloud_shell_service.transports.base.CloudShellServiceTransport, typing.Callable[[...], google.cloud.shell_v1.services.cloud_shell_service.transports.base.CloudShellServiceTransport]]] = 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 cloud shell service client.

See more: google.cloud.shell_v1.services.cloud_shell_service.CloudShellServiceClient

google.cloud.shell_v1.services.cloud_shell_service.CloudShellServiceClient.__exit__

__exit__(type, value, traceback)

Releases underlying transport's resources.

See more: google.cloud.shell_v1.services.cloud_shell_service.CloudShellServiceClient.exit

google.cloud.shell_v1.services.cloud_shell_service.CloudShellServiceClient.add_public_key

add_public_key(
 request: typing.Optional[
 typing.Union[google.cloud.shell_v1.types.cloudshell.AddPublicKeyRequest, dict]
 ] = 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

Adds a public SSH key to an environment, allowing clients with the corresponding private key to connect to that environment via SSH.

See more: google.cloud.shell_v1.services.cloud_shell_service.CloudShellServiceClient.add_public_key

google.cloud.shell_v1.services.cloud_shell_service.CloudShellServiceClient.authorize_environment

authorize_environment(
 request: typing.Optional[
 typing.Union[
 google.cloud.shell_v1.types.cloudshell.AuthorizeEnvironmentRequest, dict
 ]
 ] = 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

Sends OAuth credentials to a running environment on behalf of a user.

See more: google.cloud.shell_v1.services.cloud_shell_service.CloudShellServiceClient.authorize_environment

google.cloud.shell_v1.services.cloud_shell_service.CloudShellServiceClient.common_billing_account_path

common_billing_account_path(billing_account: str) -> str

google.cloud.shell_v1.services.cloud_shell_service.CloudShellServiceClient.common_folder_path

common_folder_path(folder: str) -> str

google.cloud.shell_v1.services.cloud_shell_service.CloudShellServiceClient.common_location_path

common_location_path(project: str, location: str) -> str

google.cloud.shell_v1.services.cloud_shell_service.CloudShellServiceClient.common_organization_path

common_organization_path(organization: str) -> str

google.cloud.shell_v1.services.cloud_shell_service.CloudShellServiceClient.common_project_path

common_project_path(project: str) -> str

google.cloud.shell_v1.services.cloud_shell_service.CloudShellServiceClient.environment_path

environment_path(user: str, environment: str) -> str

google.cloud.shell_v1.services.cloud_shell_service.CloudShellServiceClient.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.shell_v1.services.cloud_shell_service.CloudShellServiceClient.from_service_account_file

google.cloud.shell_v1.services.cloud_shell_service.CloudShellServiceClient.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.shell_v1.services.cloud_shell_service.CloudShellServiceClient.from_service_account_info

google.cloud.shell_v1.services.cloud_shell_service.CloudShellServiceClient.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.shell_v1.services.cloud_shell_service.CloudShellServiceClient.from_service_account_json

google.cloud.shell_v1.services.cloud_shell_service.CloudShellServiceClient.get_environment

get_environment(
 request: typing.Optional[
 typing.Union[google.cloud.shell_v1.types.cloudshell.GetEnvironmentRequest, 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.shell_v1.types.cloudshell.Environment

google.cloud.shell_v1.services.cloud_shell_service.CloudShellServiceClient.get_mtls_endpoint_and_cert_source

get_mtls_endpoint_and_cert_source(
 client_options: typing.Optional[
 google.api_core.client_options.ClientOptions
 ] = None,
)

google.cloud.shell_v1.services.cloud_shell_service.CloudShellServiceClient.parse_common_billing_account_path

parse_common_billing_account_path(path: str) -> typing.Dict[str, str]

google.cloud.shell_v1.services.cloud_shell_service.CloudShellServiceClient.parse_common_folder_path

parse_common_folder_path(path: str) -> typing.Dict[str, str]

google.cloud.shell_v1.services.cloud_shell_service.CloudShellServiceClient.parse_common_location_path

parse_common_location_path(path: str) -> typing.Dict[str, str]

google.cloud.shell_v1.services.cloud_shell_service.CloudShellServiceClient.parse_common_organization_path

parse_common_organization_path(path: str) -> typing.Dict[str, str]

google.cloud.shell_v1.services.cloud_shell_service.CloudShellServiceClient.parse_common_project_path

parse_common_project_path(path: str) -> typing.Dict[str, str]

google.cloud.shell_v1.services.cloud_shell_service.CloudShellServiceClient.parse_environment_path

parse_environment_path(path: str) -> typing.Dict[str, str]

Parses a environment path into its component segments.

See more: google.cloud.shell_v1.services.cloud_shell_service.CloudShellServiceClient.parse_environment_path

google.cloud.shell_v1.services.cloud_shell_service.CloudShellServiceClient.remove_public_key

remove_public_key(
 request: typing.Optional[
 typing.Union[
 google.cloud.shell_v1.types.cloudshell.RemovePublicKeyRequest, dict
 ]
 ] = 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

google.cloud.shell_v1.services.cloud_shell_service.CloudShellServiceClient.start_environment

start_environment(
 request: typing.Optional[
 typing.Union[
 google.cloud.shell_v1.types.cloudshell.StartEnvironmentRequest, dict
 ]
 ] = 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 an existing environment, allowing clients to connect to it.

See more: google.cloud.shell_v1.services.cloud_shell_service.CloudShellServiceClient.start_environment

Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025年10月30日 UTC.