NotebookServiceAsyncClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Union[str, google.cloud.notebooks_v1.services.notebook_service.transports.base.NotebookServiceTransport] = '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 Cloud AI Platform Notebooks.
Inheritance
builtins.object > NotebookServiceAsyncClientProperties
transport
Returns the transport used by the client instance.
| Type | Description |
| NotebookServiceTransport | The transport used by the client instance. |
Methods
NotebookServiceAsyncClient
NotebookServiceAsyncClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Union[str, google.cloud.notebooks_v1.services.notebook_service.transports.base.NotebookServiceTransport] = '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 notebook service client.
| Name | Description |
| 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, `.NotebookServiceTransport`]
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 |
| Type | Description |
| google.auth.exceptions.MutualTlsChannelError | If 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_environment
create_environment(request: Optional[Union[google.cloud.notebooks_v1.types.service.CreateEnvironmentRequest, dict]] = None, *, parent: Optional[str] = None, environment: Optional[google.cloud.notebooks_v1.types.environment.Environment] = None, environment_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]] = ())Creates a new Environment.
from google.cloud import notebooks_v1
async def sample_create_environment():
# Create a client
client = notebooks_v1.NotebookServiceAsyncClient()
# Initialize request argument(s)
environment = notebooks_v1.Environment()
environment.vm_image.image_name = "image_name_value"
environment.vm_image.project = "project_value"
request = notebooks_v1.CreateEnvironmentRequest(
parent="parent_value",
environment_id="environment_id_value",
environment=environment,
)
# Make the request
operation = client.create_environment(request=request)
print("Waiting for operation to complete...")
response = await operation.result()
# Handle the response
print(response)
| Name | Description |
| request |
Union[google.cloud.notebooks_v1.types.CreateEnvironmentRequest, dict]
The request object. Request for creating a notebook environment. |
| parent |
`str`
Required. Format: |
| environment |
Environment
Required. The environment to be created. This corresponds to the |
| environment_id |
`str`
Required. User-defined unique ID of this environment. The |
| 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. |
| Type | Description |
| google.api_core.operation_async.AsyncOperation | An object representing a long-running operation. The result type for the operation will be Environment Definition of a software environment that is used to start a notebook instance. |
create_execution
create_execution(request: Optional[Union[google.cloud.notebooks_v1.types.service.CreateExecutionRequest, dict]] = None, *, parent: Optional[str] = None, execution: Optional[google.cloud.notebooks_v1.types.execution.Execution] = None, execution_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]] = ())Creates a new Execution in a given project and location.
from google.cloud import notebooks_v1
async def sample_create_execution():
# Create a client
client = notebooks_v1.NotebookServiceAsyncClient()
# Initialize request argument(s)
request = notebooks_v1.CreateExecutionRequest(
parent="parent_value",
execution_id="execution_id_value",
)
# Make the request
operation = client.create_execution(request=request)
print("Waiting for operation to complete...")
response = await operation.result()
# Handle the response
print(response)
| Name | Description |
| request |
Union[google.cloud.notebooks_v1.types.CreateExecutionRequest, dict]
The request object. Request to create notebook execution |
| parent |
`str`
Required. Format: |
| execution |
Execution
Required. The execution to be created. This corresponds to the |
| execution_id |
`str`
Required. User-defined unique ID of this execution. This corresponds to the |
| 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. |
| Type | Description |
| google.api_core.operation_async.AsyncOperation | An object representing a long-running operation. The result type for the operation will be Execution The definition of a single executed notebook. |
create_instance
create_instance(request: Optional[Union[google.cloud.notebooks_v1.types.service.CreateInstanceRequest, dict]] = None, *, parent: Optional[str] = None, instance: Optional[google.cloud.notebooks_v1.types.instance.Instance] = None, instance_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]] = ())Creates a new Instance in a given project and location.
from google.cloud import notebooks_v1
async def sample_create_instance():
# Create a client
client = notebooks_v1.NotebookServiceAsyncClient()
# Initialize request argument(s)
instance = notebooks_v1.Instance()
instance.vm_image.image_name = "image_name_value"
instance.vm_image.project = "project_value"
instance.machine_type = "machine_type_value"
request = notebooks_v1.CreateInstanceRequest(
parent="parent_value",
instance_id="instance_id_value",
instance=instance,
)
# Make the request
operation = client.create_instance(request=request)
print("Waiting for operation to complete...")
response = await operation.result()
# Handle the response
print(response)
| Name | Description |
| request |
Union[google.cloud.notebooks_v1.types.CreateInstanceRequest, dict]
The request object. Request for creating a notebook instance. |
| parent |
`str`
Required. Format: |
| instance |
Instance
Required. The instance to be created. This corresponds to the |
| instance_id |
`str`
Required. User-defined unique ID of this instance. This corresponds to the |
| 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. |
| Type | Description |
| google.api_core.operation_async.AsyncOperation | An object representing a long-running operation. The result type for the operation will be Instance The definition of a notebook instance. |
create_schedule
create_schedule(request: Optional[Union[google.cloud.notebooks_v1.types.service.CreateScheduleRequest, dict]] = None, *, parent: Optional[str] = None, schedule: Optional[google.cloud.notebooks_v1.types.schedule.Schedule] = None, schedule_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]] = ())Creates a new Scheduled Notebook in a given project and location.
from google.cloud import notebooks_v1
async def sample_create_schedule():
# Create a client
client = notebooks_v1.NotebookServiceAsyncClient()
# Initialize request argument(s)
request = notebooks_v1.CreateScheduleRequest(
parent="parent_value",
schedule_id="schedule_id_value",
)
# Make the request
operation = client.create_schedule(request=request)
print("Waiting for operation to complete...")
response = await operation.result()
# Handle the response
print(response)
| Name | Description |
| request |
Union[google.cloud.notebooks_v1.types.CreateScheduleRequest, dict]
The request object. Request for created scheduled notebooks |
| parent |
`str`
Required. Format: |
| schedule |
Schedule
Required. The schedule to be created. This corresponds to the |
| schedule_id |
`str`
Required. User-defined unique ID of this schedule. This corresponds to the |
| 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. |
| Type | Description |
| google.api_core.operation_async.AsyncOperation | An object representing a long-running operation. The result type for the operation will be Schedule The definition of a schedule. |
delete_environment
delete_environment(request: Optional[Union[google.cloud.notebooks_v1.types.service.DeleteEnvironmentRequest, 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 Environment.
from google.cloud import notebooks_v1
async def sample_delete_environment():
# Create a client
client = notebooks_v1.NotebookServiceAsyncClient()
# Initialize request argument(s)
request = notebooks_v1.DeleteEnvironmentRequest(
name="name_value",
)
# Make the request
operation = client.delete_environment(request=request)
print("Waiting for operation to complete...")
response = await operation.result()
# Handle the response
print(response)
| Name | Description |
| request |
Union[google.cloud.notebooks_v1.types.DeleteEnvironmentRequest, dict]
The request object. Request for deleting a notebook environment. |
| name |
`str`
Required. Format: |
| 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. |
| Type | Description |
| google.api_core.operation_async.AsyncOperation | An 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 {}. |
delete_execution
delete_execution(request: Optional[Union[google.cloud.notebooks_v1.types.service.DeleteExecutionRequest, 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 execution
from google.cloud import notebooks_v1
async def sample_delete_execution():
# Create a client
client = notebooks_v1.NotebookServiceAsyncClient()
# Initialize request argument(s)
request = notebooks_v1.DeleteExecutionRequest(
name="name_value",
)
# Make the request
operation = client.delete_execution(request=request)
print("Waiting for operation to complete...")
response = await operation.result()
# Handle the response
print(response)
| Name | Description |
| request |
Union[google.cloud.notebooks_v1.types.DeleteExecutionRequest, dict]
The request object. Request for deleting a scheduled notebook execution |
| name |
`str`
Required. Format: |
| 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. |
| Type | Description |
| google.api_core.operation_async.AsyncOperation | An 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 {}. |
delete_instance
delete_instance(request: Optional[Union[google.cloud.notebooks_v1.types.service.DeleteInstanceRequest, 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 Instance.
from google.cloud import notebooks_v1
async def sample_delete_instance():
# Create a client
client = notebooks_v1.NotebookServiceAsyncClient()
# Initialize request argument(s)
request = notebooks_v1.DeleteInstanceRequest(
name="name_value",
)
# Make the request
operation = client.delete_instance(request=request)
print("Waiting for operation to complete...")
response = await operation.result()
# Handle the response
print(response)
| Name | Description |
| request |
Union[google.cloud.notebooks_v1.types.DeleteInstanceRequest, dict]
The request object. Request for deleting a notebook instance. |
| name |
`str`
Required. Format: |
| 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. |
| Type | Description |
| google.api_core.operation_async.AsyncOperation | An 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 {}. |
delete_schedule
delete_schedule(request: Optional[Union[google.cloud.notebooks_v1.types.service.DeleteScheduleRequest, 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 schedule and all underlying jobs
from google.cloud import notebooks_v1
async def sample_delete_schedule():
# Create a client
client = notebooks_v1.NotebookServiceAsyncClient()
# Initialize request argument(s)
request = notebooks_v1.DeleteScheduleRequest(
name="name_value",
)
# Make the request
operation = client.delete_schedule(request=request)
print("Waiting for operation to complete...")
response = await operation.result()
# Handle the response
print(response)
| Name | Description |
| request |
Union[google.cloud.notebooks_v1.types.DeleteScheduleRequest, dict]
The request object. Request for deleting an Schedule |
| name |
`str`
Required. Format: |
| 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. |
| Type | Description |
| google.api_core.operation_async.AsyncOperation | An 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 {}. |
environment_path
environment_path(project: str, environment: str)Returns a fully-qualified environment string.
execution_path
execution_path(project: str, location: str, execution: str)Returns a fully-qualified execution string.
from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)Creates an instance of this client using the provided credentials file.
| Name | Description |
| filename |
str
The path to the service account private key json file. |
| Type | Description |
| NotebookServiceAsyncClient | 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.
| Name | Description |
| info |
dict
The service account private key info. |
| Type | Description |
| NotebookServiceAsyncClient | 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.
| Name | Description |
| filename |
str
The path to the service account private key json file. |
| Type | Description |
| NotebookServiceAsyncClient | The constructed client. |
get_environment
get_environment(request: Optional[Union[google.cloud.notebooks_v1.types.service.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: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())Gets details of a single Environment.
from google.cloud import notebooks_v1
async def sample_get_environment():
# Create a client
client = notebooks_v1.NotebookServiceAsyncClient()
# Initialize request argument(s)
request = notebooks_v1.GetEnvironmentRequest(
name="name_value",
)
# Make the request
response = await client.get_environment(request=request)
# Handle the response
print(response)
| Name | Description |
| request |
Union[google.cloud.notebooks_v1.types.GetEnvironmentRequest, dict]
The request object. Request for getting a notebook environment. |
| name |
`str`
Required. Format: |
| 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. |
| Type | Description |
| google.cloud.notebooks_v1.types.Environment | Definition of a software environment that is used to start a notebook instance. |
get_execution
get_execution(request: Optional[Union[google.cloud.notebooks_v1.types.service.GetExecutionRequest, 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 executions
from google.cloud import notebooks_v1
async def sample_get_execution():
# Create a client
client = notebooks_v1.NotebookServiceAsyncClient()
# Initialize request argument(s)
request = notebooks_v1.GetExecutionRequest(
name="name_value",
)
# Make the request
response = await client.get_execution(request=request)
# Handle the response
print(response)
| Name | Description |
| request |
Union[google.cloud.notebooks_v1.types.GetExecutionRequest, dict]
The request object. Request for getting scheduled notebook execution |
| name |
`str`
Required. Format: |
| 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. |
| Type | Description |
| google.cloud.notebooks_v1.types.Execution | The definition of a single executed notebook. |
get_instance
get_instance(request: Optional[Union[google.cloud.notebooks_v1.types.service.GetInstanceRequest, 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 Instance.
from google.cloud import notebooks_v1
async def sample_get_instance():
# Create a client
client = notebooks_v1.NotebookServiceAsyncClient()
# Initialize request argument(s)
request = notebooks_v1.GetInstanceRequest(
name="name_value",
)
# Make the request
response = await client.get_instance(request=request)
# Handle the response
print(response)
| Name | Description |
| request |
Union[google.cloud.notebooks_v1.types.GetInstanceRequest, dict]
The request object. Request for getting a notebook instance. |
| name |
`str`
Required. Format: |
| 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. |
| Type | Description |
| google.cloud.notebooks_v1.types.Instance | The definition of a notebook instance. |
get_instance_health
get_instance_health(request: Optional[Union[google.cloud.notebooks_v1.types.service.GetInstanceHealthRequest, 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]] = ())Check if a notebook instance is healthy.
from google.cloud import notebooks_v1
async def sample_get_instance_health():
# Create a client
client = notebooks_v1.NotebookServiceAsyncClient()
# Initialize request argument(s)
request = notebooks_v1.GetInstanceHealthRequest(
name="name_value",
)
# Make the request
response = await client.get_instance_health(request=request)
# Handle the response
print(response)
| Name | Description |
| request |
Union[google.cloud.notebooks_v1.types.GetInstanceHealthRequest, dict]
The request object. Request for checking if a notebook instance is healthy. |
| name |
`str`
Required. Format: |
| 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. |
| Type | Description |
| google.cloud.notebooks_v1.types.GetInstanceHealthResponse | Response for checking if a notebook instance is healthy. |
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.
| Name | Description |
| client_options |
google.api_core.client_options.ClientOptions
Custom options for the client. Only the |
| Type | Description |
| google.auth.exceptions.MutualTLSChannelError | If any errors happen. |
| Type | Description |
| Tuple[str, Callable[[], Tuple[bytes, bytes]]] | returns the API endpoint and the client cert source to use. |
get_schedule
get_schedule(request: Optional[Union[google.cloud.notebooks_v1.types.service.GetScheduleRequest, 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 schedule
from google.cloud import notebooks_v1
async def sample_get_schedule():
# Create a client
client = notebooks_v1.NotebookServiceAsyncClient()
# Initialize request argument(s)
request = notebooks_v1.GetScheduleRequest(
name="name_value",
)
# Make the request
response = await client.get_schedule(request=request)
# Handle the response
print(response)
| Name | Description |
| request |
Union[google.cloud.notebooks_v1.types.GetScheduleRequest, dict]
The request object. Request for getting scheduled notebook. |
| name |
`str`
Required. Format: |
| 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. |
| Type | Description |
| google.cloud.notebooks_v1.types.Schedule | The definition of a schedule. |
get_transport_class
get_transport_class()Returns an appropriate transport class.
instance_path
instance_path(project: str, instance: str)Returns a fully-qualified instance string.
is_instance_upgradeable
is_instance_upgradeable(request: Optional[Union[google.cloud.notebooks_v1.types.service.IsInstanceUpgradeableRequest, dict]] = 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]] = ())Check if a notebook instance is upgradable.
from google.cloud import notebooks_v1
async def sample_is_instance_upgradeable():
# Create a client
client = notebooks_v1.NotebookServiceAsyncClient()
# Initialize request argument(s)
request = notebooks_v1.IsInstanceUpgradeableRequest(
notebook_instance="notebook_instance_value",
)
# Make the request
response = await client.is_instance_upgradeable(request=request)
# Handle the response
print(response)
| Name | Description |
| request |
Union[google.cloud.notebooks_v1.types.IsInstanceUpgradeableRequest, dict]
The request object. Request for checking if a notebook instance is upgradeable. |
| 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. |
| Type | Description |
| google.cloud.notebooks_v1.types.IsInstanceUpgradeableResponse | Response for checking if a notebook instance is upgradeable. |
list_environments
list_environments(request: Optional[Union[google.cloud.notebooks_v1.types.service.ListEnvironmentsRequest, 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 environments in a project.
from google.cloud import notebooks_v1
async def sample_list_environments():
# Create a client
client = notebooks_v1.NotebookServiceAsyncClient()
# Initialize request argument(s)
request = notebooks_v1.ListEnvironmentsRequest(
parent="parent_value",
)
# Make the request
page_result = client.list_environments(request=request)
# Handle the response
async for response in page_result:
print(response)
| Name | Description |
| request |
Union[google.cloud.notebooks_v1.types.ListEnvironmentsRequest, dict]
The request object. Request for listing environments. |
| parent |
`str`
Required. Format: |
| 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. |
| Type | Description |
| google.cloud.notebooks_v1.services.notebook_service.pagers.ListEnvironmentsAsyncPager | Response for listing environments. Iterating over this object will yield results and resolve additional pages automatically. |
list_executions
list_executions(request: Optional[Union[google.cloud.notebooks_v1.types.service.ListExecutionsRequest, 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 executions in a given project and location
from google.cloud import notebooks_v1
async def sample_list_executions():
# Create a client
client = notebooks_v1.NotebookServiceAsyncClient()
# Initialize request argument(s)
request = notebooks_v1.ListExecutionsRequest(
parent="parent_value",
)
# Make the request
page_result = client.list_executions(request=request)
# Handle the response
async for response in page_result:
print(response)
| Name | Description |
| request |
Union[google.cloud.notebooks_v1.types.ListExecutionsRequest, dict]
The request object. Request for listing scheduled notebook executions. |
| parent |
`str`
Required. Format: |
| 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. |
| Type | Description |
| google.cloud.notebooks_v1.services.notebook_service.pagers.ListExecutionsAsyncPager | Response for listing scheduled notebook executions Iterating over this object will yield results and resolve additional pages automatically. |
list_instances
list_instances(request: Optional[Union[google.cloud.notebooks_v1.types.service.ListInstancesRequest, 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 instances in a given project and location.
from google.cloud import notebooks_v1
async def sample_list_instances():
# Create a client
client = notebooks_v1.NotebookServiceAsyncClient()
# Initialize request argument(s)
request = notebooks_v1.ListInstancesRequest(
parent="parent_value",
)
# Make the request
page_result = client.list_instances(request=request)
# Handle the response
async for response in page_result:
print(response)
| Name | Description |
| request |
Union[google.cloud.notebooks_v1.types.ListInstancesRequest, dict]
The request object. Request for listing notebook instances. |
| parent |
`str`
Required. Format: |
| 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. |
| Type | Description |
| google.cloud.notebooks_v1.services.notebook_service.pagers.ListInstancesAsyncPager | Response for listing notebook instances. Iterating over this object will yield results and resolve additional pages automatically. |
list_schedules
list_schedules(request: Optional[Union[google.cloud.notebooks_v1.types.service.ListSchedulesRequest, 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 schedules in a given project and location.
from google.cloud import notebooks_v1
async def sample_list_schedules():
# Create a client
client = notebooks_v1.NotebookServiceAsyncClient()
# Initialize request argument(s)
request = notebooks_v1.ListSchedulesRequest(
parent="parent_value",
)
# Make the request
page_result = client.list_schedules(request=request)
# Handle the response
async for response in page_result:
print(response)
| Name | Description |
| request |
Union[google.cloud.notebooks_v1.types.ListSchedulesRequest, dict]
The request object. Request for listing scheduled notebook job. |
| parent |
`str`
Required. Format: |
| 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. |
| Type | Description |
| google.cloud.notebooks_v1.services.notebook_service.pagers.ListSchedulesAsyncPager | Response for listing scheduled notebook job. 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_environment_path
parse_environment_path(path: str)Parses a environment path into its component segments.
parse_execution_path
parse_execution_path(path: str)Parses a execution path into its component segments.
parse_instance_path
parse_instance_path(path: str)Parses a instance path into its component segments.
parse_schedule_path
parse_schedule_path(path: str)Parses a schedule path into its component segments.
parse_tensorboard_path
parse_tensorboard_path(path: str)Parses a tensorboard path into its component segments.
register_instance
register_instance(request: Optional[Union[google.cloud.notebooks_v1.types.service.RegisterInstanceRequest, dict]] = 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]] = ())Registers an existing legacy notebook instance to the Notebooks API server. Legacy instances are instances created with the legacy Compute Engine calls. They are not manageable by the Notebooks API out of the box. This call makes these instances manageable by the Notebooks API.
from google.cloud import notebooks_v1
async def sample_register_instance():
# Create a client
client = notebooks_v1.NotebookServiceAsyncClient()
# Initialize request argument(s)
request = notebooks_v1.RegisterInstanceRequest(
parent="parent_value",
instance_id="instance_id_value",
)
# Make the request
operation = client.register_instance(request=request)
print("Waiting for operation to complete...")
response = await operation.result()
# Handle the response
print(response)
| Name | Description |
| request |
Union[google.cloud.notebooks_v1.types.RegisterInstanceRequest, dict]
The request object. Request for registering a notebook instance. |
| 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. |
| Type | Description |
| google.api_core.operation_async.AsyncOperation | An object representing a long-running operation. The result type for the operation will be Instance The definition of a notebook instance. |
report_instance_info
report_instance_info(request: Optional[Union[google.cloud.notebooks_v1.types.service.ReportInstanceInfoRequest, dict]] = 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]] = ())Allows notebook instances to report their latest instance information to the Notebooks API server. The server will merge the reported information to the instance metadata store. Do not use this method directly.
from google.cloud import notebooks_v1
async def sample_report_instance_info():
# Create a client
client = notebooks_v1.NotebookServiceAsyncClient()
# Initialize request argument(s)
request = notebooks_v1.ReportInstanceInfoRequest(
name="name_value",
vm_id="vm_id_value",
)
# Make the request
operation = client.report_instance_info(request=request)
print("Waiting for operation to complete...")
response = await operation.result()
# Handle the response
print(response)
| Name | Description |
| request |
Union[google.cloud.notebooks_v1.types.ReportInstanceInfoRequest, dict]
The request object. Request for notebook instances to report information to Notebooks API. |
| 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. |
| Type | Description |
| google.api_core.operation_async.AsyncOperation | An object representing a long-running operation. The result type for the operation will be Instance The definition of a notebook instance. |
reset_instance
reset_instance(request: Optional[Union[google.cloud.notebooks_v1.types.service.ResetInstanceRequest, dict]] = 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 notebook instance.
from google.cloud import notebooks_v1
async def sample_reset_instance():
# Create a client
client = notebooks_v1.NotebookServiceAsyncClient()
# Initialize request argument(s)
request = notebooks_v1.ResetInstanceRequest(
name="name_value",
)
# Make the request
operation = client.reset_instance(request=request)
print("Waiting for operation to complete...")
response = await operation.result()
# Handle the response
print(response)
| Name | Description |
| request |
Union[google.cloud.notebooks_v1.types.ResetInstanceRequest, dict]
The request object. Request for resetting a notebook instance |
| 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. |
| Type | Description |
| google.api_core.operation_async.AsyncOperation | An object representing a long-running operation. The result type for the operation will be Instance The definition of a notebook instance. |
rollback_instance
rollback_instance(request: Optional[Union[google.cloud.notebooks_v1.types.service.RollbackInstanceRequest, dict]] = 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]] = ())Rollbacks a notebook instance to the previous version.
from google.cloud import notebooks_v1
async def sample_rollback_instance():
# Create a client
client = notebooks_v1.NotebookServiceAsyncClient()
# Initialize request argument(s)
request = notebooks_v1.RollbackInstanceRequest(
name="name_value",
target_snapshot="target_snapshot_value",
)
# Make the request
operation = client.rollback_instance(request=request)
print("Waiting for operation to complete...")
response = await operation.result()
# Handle the response
print(response)
| Name | Description |
| request |
Union[google.cloud.notebooks_v1.types.RollbackInstanceRequest, dict]
The request object. Request for rollbacking a notebook instance |
| 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. |
| Type | Description |
| google.api_core.operation_async.AsyncOperation | An object representing a long-running operation. The result type for the operation will be Instance The definition of a notebook instance. |
schedule_path
schedule_path(project: str, location: str, schedule: str)Returns a fully-qualified schedule string.
set_instance_accelerator
set_instance_accelerator(request: Optional[Union[google.cloud.notebooks_v1.types.service.SetInstanceAcceleratorRequest, dict]] = 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]] = ())Updates the guest accelerators of a single Instance.
from google.cloud import notebooks_v1
async def sample_set_instance_accelerator():
# Create a client
client = notebooks_v1.NotebookServiceAsyncClient()
# Initialize request argument(s)
request = notebooks_v1.SetInstanceAcceleratorRequest(
name="name_value",
type_="TPU_V3",
core_count=1073,
)
# Make the request
operation = client.set_instance_accelerator(request=request)
print("Waiting for operation to complete...")
response = await operation.result()
# Handle the response
print(response)
| Name | Description |
| request |
Union[google.cloud.notebooks_v1.types.SetInstanceAcceleratorRequest, dict]
The request object. Request for setting instance accelerator. |
| 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. |
| Type | Description |
| google.api_core.operation_async.AsyncOperation | An object representing a long-running operation. The result type for the operation will be Instance The definition of a notebook instance. |
set_instance_labels
set_instance_labels(request: Optional[Union[google.cloud.notebooks_v1.types.service.SetInstanceLabelsRequest, dict]] = 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]] = ())Replaces all the labels of an Instance.
from google.cloud import notebooks_v1
async def sample_set_instance_labels():
# Create a client
client = notebooks_v1.NotebookServiceAsyncClient()
# Initialize request argument(s)
request = notebooks_v1.SetInstanceLabelsRequest(
name="name_value",
)
# Make the request
operation = client.set_instance_labels(request=request)
print("Waiting for operation to complete...")
response = await operation.result()
# Handle the response
print(response)
| Name | Description |
| request |
Union[google.cloud.notebooks_v1.types.SetInstanceLabelsRequest, dict]
The request object. Request for setting instance labels. |
| 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. |
| Type | Description |
| google.api_core.operation_async.AsyncOperation | An object representing a long-running operation. The result type for the operation will be Instance The definition of a notebook instance. |
set_instance_machine_type
set_instance_machine_type(request: Optional[Union[google.cloud.notebooks_v1.types.service.SetInstanceMachineTypeRequest, dict]] = 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]] = ())Updates the machine type of a single Instance.
from google.cloud import notebooks_v1
async def sample_set_instance_machine_type():
# Create a client
client = notebooks_v1.NotebookServiceAsyncClient()
# Initialize request argument(s)
request = notebooks_v1.SetInstanceMachineTypeRequest(
name="name_value",
machine_type="machine_type_value",
)
# Make the request
operation = client.set_instance_machine_type(request=request)
print("Waiting for operation to complete...")
response = await operation.result()
# Handle the response
print(response)
| Name | Description |
| request |
Union[google.cloud.notebooks_v1.types.SetInstanceMachineTypeRequest, dict]
The request object. Request for setting instance machine type. |
| 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. |
| Type | Description |
| google.api_core.operation_async.AsyncOperation | An object representing a long-running operation. The result type for the operation will be Instance The definition of a notebook instance. |
start_instance
start_instance(request: Optional[Union[google.cloud.notebooks_v1.types.service.StartInstanceRequest, dict]] = 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 notebook instance.
from google.cloud import notebooks_v1
async def sample_start_instance():
# Create a client
client = notebooks_v1.NotebookServiceAsyncClient()
# Initialize request argument(s)
request = notebooks_v1.StartInstanceRequest(
name="name_value",
)
# Make the request
operation = client.start_instance(request=request)
print("Waiting for operation to complete...")
response = await operation.result()
# Handle the response
print(response)
| Name | Description |
| request |
Union[google.cloud.notebooks_v1.types.StartInstanceRequest, dict]
The request object. Request for starting a notebook instance |
| 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. |
| Type | Description |
| google.api_core.operation_async.AsyncOperation | An object representing a long-running operation. The result type for the operation will be Instance The definition of a notebook instance. |
stop_instance
stop_instance(request: Optional[Union[google.cloud.notebooks_v1.types.service.StopInstanceRequest, dict]] = 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 notebook instance.
from google.cloud import notebooks_v1
async def sample_stop_instance():
# Create a client
client = notebooks_v1.NotebookServiceAsyncClient()
# Initialize request argument(s)
request = notebooks_v1.StopInstanceRequest(
name="name_value",
)
# Make the request
operation = client.stop_instance(request=request)
print("Waiting for operation to complete...")
response = await operation.result()
# Handle the response
print(response)
| Name | Description |
| request |
Union[google.cloud.notebooks_v1.types.StopInstanceRequest, dict]
The request object. Request for stopping a notebook instance |
| 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. |
| Type | Description |
| google.api_core.operation_async.AsyncOperation | An object representing a long-running operation. The result type for the operation will be Instance The definition of a notebook instance. |
tensorboard_path
tensorboard_path(project: str, location: str, tensorboard: str)Returns a fully-qualified tensorboard string.
trigger_schedule
trigger_schedule(request: Optional[Union[google.cloud.notebooks_v1.types.service.TriggerScheduleRequest, dict]] = 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]] = ())Triggers execution of an existing schedule.
from google.cloud import notebooks_v1
async def sample_trigger_schedule():
# Create a client
client = notebooks_v1.NotebookServiceAsyncClient()
# Initialize request argument(s)
request = notebooks_v1.TriggerScheduleRequest(
name="name_value",
)
# Make the request
operation = client.trigger_schedule(request=request)
print("Waiting for operation to complete...")
response = await operation.result()
# Handle the response
print(response)
| Name | Description |
| request |
Union[google.cloud.notebooks_v1.types.TriggerScheduleRequest, dict]
The request object. Request for created scheduled notebooks |
| 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. |
| Type | Description |
| google.api_core.operation_async.AsyncOperation | An object representing a long-running operation. The result type for the operation will be Schedule The definition of a schedule. |
update_instance_config
update_instance_config(request: Optional[Union[google.cloud.notebooks_v1.types.service.UpdateInstanceConfigRequest, dict]] = 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]] = ())Update Notebook Instance configurations.
from google.cloud import notebooks_v1
async def sample_update_instance_config():
# Create a client
client = notebooks_v1.NotebookServiceAsyncClient()
# Initialize request argument(s)
request = notebooks_v1.UpdateInstanceConfigRequest(
name="name_value",
)
# Make the request
operation = client.update_instance_config(request=request)
print("Waiting for operation to complete...")
response = await operation.result()
# Handle the response
print(response)
| Name | Description |
| request |
Union[google.cloud.notebooks_v1.types.UpdateInstanceConfigRequest, dict]
The request object. Request for updating instance configurations. |
| 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. |
| Type | Description |
| google.api_core.operation_async.AsyncOperation | An object representing a long-running operation. The result type for the operation will be Instance The definition of a notebook instance. |
update_instance_metadata_items
update_instance_metadata_items(request: Optional[Union[google.cloud.notebooks_v1.types.service.UpdateInstanceMetadataItemsRequest, dict]] = 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]] = ())Add/update metadata items for an instance.
from google.cloud import notebooks_v1
async def sample_update_instance_metadata_items():
# Create a client
client = notebooks_v1.NotebookServiceAsyncClient()
# Initialize request argument(s)
request = notebooks_v1.UpdateInstanceMetadataItemsRequest(
name="name_value",
)
# Make the request
response = await client.update_instance_metadata_items(request=request)
# Handle the response
print(response)
| Name | Description |
| request |
Union[google.cloud.notebooks_v1.types.UpdateInstanceMetadataItemsRequest, dict]
The request object. Request for adding/changing metadata items for an instance. |
| 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. |
| Type | Description |
| google.cloud.notebooks_v1.types.UpdateInstanceMetadataItemsResponse | Response for adding/changing metadata items for an instance. |
update_shielded_instance_config
update_shielded_instance_config(request: Optional[Union[google.cloud.notebooks_v1.types.service.UpdateShieldedInstanceConfigRequest, dict]] = 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]] = ())Updates the Shielded instance configuration of a single Instance.
from google.cloud import notebooks_v1
async def sample_update_shielded_instance_config():
# Create a client
client = notebooks_v1.NotebookServiceAsyncClient()
# Initialize request argument(s)
request = notebooks_v1.UpdateShieldedInstanceConfigRequest(
name="name_value",
)
# Make the request
operation = client.update_shielded_instance_config(request=request)
print("Waiting for operation to complete...")
response = await operation.result()
# Handle the response
print(response)
| Name | Description |
| request |
Union[google.cloud.notebooks_v1.types.UpdateShieldedInstanceConfigRequest, dict]
The request object. Request for updating the Shielded Instance config for a notebook instance. You can only use this method on a stopped instance |
| 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. |
| Type | Description |
| google.api_core.operation_async.AsyncOperation | An object representing a long-running operation. The result type for the operation will be Instance The definition of a notebook instance. |
upgrade_instance
upgrade_instance(request: Optional[Union[google.cloud.notebooks_v1.types.service.UpgradeInstanceRequest, dict]] = 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]] = ())Upgrades a notebook instance to the latest version.
from google.cloud import notebooks_v1
async def sample_upgrade_instance():
# Create a client
client = notebooks_v1.NotebookServiceAsyncClient()
# Initialize request argument(s)
request = notebooks_v1.UpgradeInstanceRequest(
name="name_value",
)
# Make the request
operation = client.upgrade_instance(request=request)
print("Waiting for operation to complete...")
response = await operation.result()
# Handle the response
print(response)
| Name | Description |
| request |
Union[google.cloud.notebooks_v1.types.UpgradeInstanceRequest, dict]
The request object. Request for upgrading a notebook instance |
| 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. |
| Type | Description |
| google.api_core.operation_async.AsyncOperation | An object representing a long-running operation. The result type for the operation will be Instance The definition of a notebook instance. |
upgrade_instance_internal
upgrade_instance_internal(request: Optional[Union[google.cloud.notebooks_v1.types.service.UpgradeInstanceInternalRequest, dict]] = 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]] = ())Allows notebook instances to call this endpoint to upgrade themselves. Do not use this method directly.
from google.cloud import notebooks_v1
async def sample_upgrade_instance_internal():
# Create a client
client = notebooks_v1.NotebookServiceAsyncClient()
# Initialize request argument(s)
request = notebooks_v1.UpgradeInstanceInternalRequest(
name="name_value",
vm_id="vm_id_value",
)
# Make the request
operation = client.upgrade_instance_internal(request=request)
print("Waiting for operation to complete...")
response = await operation.result()
# Handle the response
print(response)
| Name | Description |
| request |
Union[google.cloud.notebooks_v1.types.UpgradeInstanceInternalRequest, dict]
The request object. Request for upgrading a notebook instance from within the VM |
| 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. |
| Type | Description |
| google.api_core.operation_async.AsyncOperation | An object representing a long-running operation. The result type for the operation will be Instance The definition of a notebook instance. |