Class ManagedNotebookServiceAsyncClient

ManagedNotebookServiceAsyncClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Union[str, google.cloud.notebooks_v1.services.managed_notebook_service.transports.base.ManagedNotebookServiceTransport] = '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 v1 service for Managed Notebooks.

Inheritance

builtins.object > ManagedNotebookServiceAsyncClient

Properties

transport

Returns the transport used by the client instance.

Returns
TypeDescription
ManagedNotebookServiceTransportThe transport used by the client instance.

Methods

ManagedNotebookServiceAsyncClient

ManagedNotebookServiceAsyncClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Union[str, google.cloud.notebooks_v1.services.managed_notebook_service.transports.base.ManagedNotebookServiceTransport] = '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 managed notebook service client.

Parameters
NameDescription
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, `.ManagedNotebookServiceTransport`]

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.

Exceptions
TypeDescription
google.auth.exceptions.MutualTlsChannelErrorIf mutual TLS transport creation failed for any reason.

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.

create_runtime

create_runtime(request: Optional[Union[google.cloud.notebooks_v1.types.managed_service.CreateRuntimeRequest, dict]] = None, *, parent: Optional[str] = None, runtime_id: Optional[str] = None, runtime: Optional[google.cloud.notebooks_v1.types.runtime.Runtime] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Creates a new Runtime in a given project and location.

from google.cloud import notebooks_v1

def sample_create_runtime():
    # Create a client
    client = notebooks_v1.ManagedNotebookServiceClient()

    # Initialize request argument(s)
    request = notebooks_v1.CreateRuntimeRequest(
        parent="parent_value",
        runtime_id="runtime_id_value",
    )

    # Make the request
    operation = client.create_runtime(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)
Parameters
NameDescription
request Union[google.cloud.notebooks_v1.types.CreateRuntimeRequest, dict]

The request object. Request for creating a Managed Notebook Runtime.

parent `str`

Required. Format: parent=projects/{project_id}/locations/{location} This corresponds to the parent field on the request instance; if request is provided, this should not be set.

runtime_id `str`

Required. User-defined unique ID of this Runtime. This corresponds to the runtime_id field on the request instance; if request is provided, this should not be set.

runtime Runtime

Required. The Runtime to be created. This corresponds to the runtime 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.

Returns
TypeDescription
google.api_core.operation_async.AsyncOperationAn object representing a long-running operation. The result type for the operation will be Runtime The definition of a Runtime for a managed notebook instance.

delete_runtime

delete_runtime(request: Optional[Union[google.cloud.notebooks_v1.types.managed_service.DeleteRuntimeRequest, 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: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Deletes a single Runtime.

from google.cloud import notebooks_v1

def sample_delete_runtime():
    # Create a client
    client = notebooks_v1.ManagedNotebookServiceClient()

    # Initialize request argument(s)
    request = notebooks_v1.DeleteRuntimeRequest(
        name="name_value",
    )

    # Make the request
    operation = client.delete_runtime(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)
Parameters
NameDescription
request Union[google.cloud.notebooks_v1.types.DeleteRuntimeRequest, dict]

The request object. Request for deleting a Managed Notebook Runtime.

name `str`

Required. Format: projects/{project_id}/locations/{location}/runtimes/{runtime_id} 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.

Returns
TypeDescription
google.api_core.operation_async.AsyncOperationAn object representing a long-running operation. The result type for the operation will be `google.protobuf.empty_pb2.Empty` A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for Empty is empty JSON object {}.

from_service_account_file

from_service_account_file(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

Parameter
NameDescription
filename str

The path to the service account private key json file.

Returns
TypeDescription
ManagedNotebookServiceAsyncClientThe 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.

Parameter
NameDescription
info dict

The service account private key info.

Returns
TypeDescription
ManagedNotebookServiceAsyncClientThe 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.

Parameter
NameDescription
filename str

The path to the service account private key json file.

Returns
TypeDescription
ManagedNotebookServiceAsyncClientThe constructed client.

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.

Parameter
NameDescription
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.

Exceptions
TypeDescription
google.auth.exceptions.MutualTLSChannelErrorIf any errors happen.
Returns
TypeDescription
Tuple[str, Callable[[], Tuple[bytes, bytes]]]returns the API endpoint and the client cert source to use.

get_runtime

get_runtime(request: Optional[Union[google.cloud.notebooks_v1.types.managed_service.GetRuntimeRequest, 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: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Gets details of a single Runtime. The location must be a regional endpoint rather than zonal.

from google.cloud import notebooks_v1

def sample_get_runtime():
    # Create a client
    client = notebooks_v1.ManagedNotebookServiceClient()

    # Initialize request argument(s)
    request = notebooks_v1.GetRuntimeRequest(
        name="name_value",
    )

    # Make the request
    response = client.get_runtime(request=request)

    # Handle the response
    print(response)
Parameters
NameDescription
request Union[google.cloud.notebooks_v1.types.GetRuntimeRequest, dict]

The request object. Request for getting a Managed Notebook Runtime.

name `str`

Required. Format: projects/{project_id}/locations/{location}/runtimes/{runtime_id} 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.

Returns
TypeDescription
google.cloud.notebooks_v1.types.RuntimeThe definition of a Runtime for a managed notebook instance.

get_transport_class

get_transport_class()

Returns an appropriate transport class.

list_runtimes

list_runtimes(request: Optional[Union[google.cloud.notebooks_v1.types.managed_service.ListRuntimesRequest, dict]] = None, *, parent: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Lists Runtimes in a given project and location.

from google.cloud import notebooks_v1

def sample_list_runtimes():
    # Create a client
    client = notebooks_v1.ManagedNotebookServiceClient()

    # Initialize request argument(s)
    request = notebooks_v1.ListRuntimesRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_runtimes(request=request)

    # Handle the response
    for response in page_result:
        print(response)
Parameters
NameDescription
request Union[google.cloud.notebooks_v1.types.ListRuntimesRequest, dict]

The request object. Request for listing Managed Notebook Runtimes.

parent `str`

Required. Format: parent=projects/{project_id}/locations/{location} This corresponds to the parent 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.

Returns
TypeDescription
google.cloud.notebooks_v1.services.managed_notebook_service.pagers.ListRuntimesAsyncPagerResponse for listing Managed Notebook Runtimes. Iterating over this object will yield results and resolve additional pages automatically.

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_runtime_path

parse_runtime_path(path: str)

Parses a runtime path into its component segments.

refresh_runtime_token_internal

refresh_runtime_token_internal(request: Optional[Union[google.cloud.notebooks_v1.types.managed_service.RefreshRuntimeTokenInternalRequest, dict]] = None, *, name: Optional[str] = None, vm_id: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Gets an access token for the consumer service account that the customer attached to the runtime. Only accessible from the tenant instance.

from google.cloud import notebooks_v1

def sample_refresh_runtime_token_internal():
    # Create a client
    client = notebooks_v1.ManagedNotebookServiceClient()

    # Initialize request argument(s)
    request = notebooks_v1.RefreshRuntimeTokenInternalRequest(
        name="name_value",
        vm_id="vm_id_value",
    )

    # Make the request
    response = client.refresh_runtime_token_internal(request=request)

    # Handle the response
    print(response)
Parameters
NameDescription
request Union[google.cloud.notebooks_v1.types.RefreshRuntimeTokenInternalRequest, dict]

The request object. Request for getting a new access token.

name `str`

Required. Format: projects/{project_id}/locations/{location}/runtimes/{runtime_id} This corresponds to the name field on the request instance; if request is provided, this should not be set.

vm_id `str`

Required. The VM hardware token for authenticating the VM. https://cloud.google.com/compute/docs/instances/verifying-instance-identity This corresponds to the vm_id 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.

Returns
TypeDescription
google.cloud.notebooks_v1.types.RefreshRuntimeTokenInternalResponseResponse with a new access token.

report_runtime_event

report_runtime_event(request: Optional[Union[google.cloud.notebooks_v1.types.managed_service.ReportRuntimeEventRequest, 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: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Report and process a runtime event.

from google.cloud import notebooks_v1

def sample_report_runtime_event():
    # Create a client
    client = notebooks_v1.ManagedNotebookServiceClient()

    # Initialize request argument(s)
    request = notebooks_v1.ReportRuntimeEventRequest(
        name="name_value",
        vm_id="vm_id_value",
    )

    # Make the request
    operation = client.report_runtime_event(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)
Parameters
NameDescription
request Union[google.cloud.notebooks_v1.types.ReportRuntimeEventRequest, dict]

The request object. Request for reporting a Managed Notebook Event.

name `str`

Required. Format: projects/{project_id}/locations/{location}/runtimes/{runtime_id} 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.

Returns
TypeDescription
google.api_core.operation_async.AsyncOperationAn object representing a long-running operation. The result type for the operation will be Runtime The definition of a Runtime for a managed notebook instance.

reset_runtime

reset_runtime(request: Optional[Union[google.cloud.notebooks_v1.types.managed_service.ResetRuntimeRequest, 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: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Resets a Managed Notebook Runtime.

from google.cloud import notebooks_v1

def sample_reset_runtime():
    # Create a client
    client = notebooks_v1.ManagedNotebookServiceClient()

    # Initialize request argument(s)
    request = notebooks_v1.ResetRuntimeRequest(
        name="name_value",
    )

    # Make the request
    operation = client.reset_runtime(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)
Parameters
NameDescription
request Union[google.cloud.notebooks_v1.types.ResetRuntimeRequest, dict]

The request object. Request for resetting a Managed Notebook Runtime.

name `str`

Required. Format: projects/{project_id}/locations/{location}/runtimes/{runtime_id} 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.

Returns
TypeDescription
google.api_core.operation_async.AsyncOperationAn object representing a long-running operation. The result type for the operation will be Runtime The definition of a Runtime for a managed notebook instance.

runtime_path

runtime_path(project: str, location: str, runtime: str)

Returns a fully-qualified runtime string.

start_runtime

start_runtime(request: Optional[Union[google.cloud.notebooks_v1.types.managed_service.StartRuntimeRequest, 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: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Starts a Managed Notebook Runtime. Perform "Start" on GPU instances; "Resume" on CPU instances See: https://cloud.google.com/compute/docs/instances/stop-start-instance https://cloud.google.com/compute/docs/instances/suspend-resume-instance

from google.cloud import notebooks_v1

def sample_start_runtime():
    # Create a client
    client = notebooks_v1.ManagedNotebookServiceClient()

    # Initialize request argument(s)
    request = notebooks_v1.StartRuntimeRequest(
        name="name_value",
    )

    # Make the request
    operation = client.start_runtime(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)
Parameters
NameDescription
request Union[google.cloud.notebooks_v1.types.StartRuntimeRequest, dict]

The request object. Request for starting a Managed Notebook Runtime.

name `str`

Required. Format: projects/{project_id}/locations/{location}/runtimes/{runtime_id} 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.

Returns
TypeDescription
google.api_core.operation_async.AsyncOperationAn object representing a long-running operation. The result type for the operation will be Runtime The definition of a Runtime for a managed notebook instance.

stop_runtime

stop_runtime(request: Optional[Union[google.cloud.notebooks_v1.types.managed_service.StopRuntimeRequest, 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: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Stops a Managed Notebook Runtime. Perform "Stop" on GPU instances; "Suspend" on CPU instances See: https://cloud.google.com/compute/docs/instances/stop-start-instance https://cloud.google.com/compute/docs/instances/suspend-resume-instance

from google.cloud import notebooks_v1

def sample_stop_runtime():
    # Create a client
    client = notebooks_v1.ManagedNotebookServiceClient()

    # Initialize request argument(s)
    request = notebooks_v1.StopRuntimeRequest(
        name="name_value",
    )

    # Make the request
    operation = client.stop_runtime(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)
Parameters
NameDescription
request Union[google.cloud.notebooks_v1.types.StopRuntimeRequest, dict]

The request object. Request for stopping a Managed Notebook Runtime.

name `str`

Required. Format: projects/{project_id}/locations/{location}/runtimes/{runtime_id} 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.

Returns
TypeDescription
google.api_core.operation_async.AsyncOperationAn object representing a long-running operation. The result type for the operation will be Runtime The definition of a Runtime for a managed notebook instance.

switch_runtime

switch_runtime(request: Optional[Union[google.cloud.notebooks_v1.types.managed_service.SwitchRuntimeRequest, 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: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Switch a Managed Notebook Runtime.

from google.cloud import notebooks_v1

def sample_switch_runtime():
    # Create a client
    client = notebooks_v1.ManagedNotebookServiceClient()

    # Initialize request argument(s)
    request = notebooks_v1.SwitchRuntimeRequest(
        name="name_value",
    )

    # Make the request
    operation = client.switch_runtime(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)
Parameters
NameDescription
request Union[google.cloud.notebooks_v1.types.SwitchRuntimeRequest, dict]

The request object. Request for switching a Managed Notebook Runtime.

name `str`

Required. Format: projects/{project_id}/locations/{location}/runtimes/{runtime_id} 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.

Returns
TypeDescription
google.api_core.operation_async.AsyncOperationAn object representing a long-running operation. The result type for the operation will be Runtime The definition of a Runtime for a managed notebook instance.