Summary of entries of Methods for notebooks.
google.cloud.notebooks_v1.services.managed_notebook_service.ManagedNotebookServiceAsyncClient
ManagedNotebookServiceAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.notebooks_v1.services.managed_notebook_service.transports.base.ManagedNotebookServiceTransport, typing.Callable[[...], google.cloud.notebooks_v1.services.managed_notebook_service.transports.base.ManagedNotebookServiceTransport]]] = '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 managed notebook service async client.
See more: google.cloud.notebooks_v1.services.managed_notebook_service.ManagedNotebookServiceAsyncClient
google.cloud.notebooks_v1.services.managed_notebook_service.ManagedNotebookServiceAsyncClient.cancel_operation
cancel_operation(
request: typing.Optional[
google.longrunning.operations_pb2.CancelOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Starts asynchronous cancellation on a long-running operation.
google.cloud.notebooks_v1.services.managed_notebook_service.ManagedNotebookServiceAsyncClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
google.cloud.notebooks_v1.services.managed_notebook_service.ManagedNotebookServiceAsyncClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
google.cloud.notebooks_v1.services.managed_notebook_service.ManagedNotebookServiceAsyncClient.common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
google.cloud.notebooks_v1.services.managed_notebook_service.ManagedNotebookServiceAsyncClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
google.cloud.notebooks_v1.services.managed_notebook_service.ManagedNotebookServiceAsyncClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
google.cloud.notebooks_v1.services.managed_notebook_service.ManagedNotebookServiceAsyncClient.create_runtime
create_runtime(
request: typing.Optional[
typing.Union[
google.cloud.notebooks_v1.types.managed_service.CreateRuntimeRequest, dict
]
] = None,
*,
parent: typing.Optional[str] = None,
runtime_id: typing.Optional[str] = None,
runtime: typing.Optional[google.cloud.notebooks_v1.types.runtime.Runtime] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Creates a new Runtime in a given project and location.
google.cloud.notebooks_v1.services.managed_notebook_service.ManagedNotebookServiceAsyncClient.delete_operation
delete_operation(
request: typing.Optional[
google.longrunning.operations_pb2.DeleteOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Deletes a long-running operation.
google.cloud.notebooks_v1.services.managed_notebook_service.ManagedNotebookServiceAsyncClient.delete_runtime
delete_runtime(
request: typing.Optional[
typing.Union[
google.cloud.notebooks_v1.types.managed_service.DeleteRuntimeRequest, dict
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Deletes a single Runtime.
google.cloud.notebooks_v1.services.managed_notebook_service.ManagedNotebookServiceAsyncClient.diagnose_runtime
diagnose_runtime(
request: typing.Optional[
typing.Union[
google.cloud.notebooks_v1.types.managed_service.DiagnoseRuntimeRequest, dict
]
] = None,
*,
name: typing.Optional[str] = None,
diagnostic_config: typing.Optional[
google.cloud.notebooks_v1.types.diagnostic_config.DiagnosticConfig
] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Creates a Diagnostic File and runs Diagnostic Tool given a Runtime.
google.cloud.notebooks_v1.services.managed_notebook_service.ManagedNotebookServiceAsyncClient.from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.notebooks_v1.services.managed_notebook_service.ManagedNotebookServiceAsyncClient.from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)
Creates an instance of this client using the provided credentials info.
google.cloud.notebooks_v1.services.managed_notebook_service.ManagedNotebookServiceAsyncClient.from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.notebooks_v1.services.managed_notebook_service.ManagedNotebookServiceAsyncClient.get_iam_policy
get_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Gets the IAM access control policy for a function.
google.cloud.notebooks_v1.services.managed_notebook_service.ManagedNotebookServiceAsyncClient.get_location
get_location(
request: typing.Optional[
google.cloud.location.locations_pb2.GetLocationRequest
] = 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.location.locations_pb2.Location
Gets information about a location.
google.cloud.notebooks_v1.services.managed_notebook_service.ManagedNotebookServiceAsyncClient.get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: typing.Optional[
google.api_core.client_options.ClientOptions
] = None,
)
Return the API endpoint and client cert source for mutual TLS.
google.cloud.notebooks_v1.services.managed_notebook_service.ManagedNotebookServiceAsyncClient.get_operation
get_operation(
request: typing.Optional[
google.longrunning.operations_pb2.GetOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Gets the latest state of a long-running operation.
google.cloud.notebooks_v1.services.managed_notebook_service.ManagedNotebookServiceAsyncClient.get_runtime
get_runtime(
request: typing.Optional[
typing.Union[
google.cloud.notebooks_v1.types.managed_service.GetRuntimeRequest, 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.notebooks_v1.types.runtime.Runtime
Gets details of a single Runtime.
google.cloud.notebooks_v1.services.managed_notebook_service.ManagedNotebookServiceAsyncClient.get_transport_class
get_transport_class() -> (
typing.Type[
google.cloud.notebooks_v1.services.managed_notebook_service.transports.base.ManagedNotebookServiceTransport
]
)
Returns an appropriate transport class.
google.cloud.notebooks_v1.services.managed_notebook_service.ManagedNotebookServiceAsyncClient.list_locations
list_locations(
request: typing.Optional[
google.cloud.location.locations_pb2.ListLocationsRequest
] = 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.location.locations_pb2.ListLocationsResponse
Lists information about the supported locations for this service.
google.cloud.notebooks_v1.services.managed_notebook_service.ManagedNotebookServiceAsyncClient.list_operations
list_operations(
request: typing.Optional[
google.longrunning.operations_pb2.ListOperationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse
Lists operations that match the specified filter in the request.
google.cloud.notebooks_v1.services.managed_notebook_service.ManagedNotebookServiceAsyncClient.list_runtimes
list_runtimes(
request: typing.Optional[
typing.Union[
google.cloud.notebooks_v1.types.managed_service.ListRuntimesRequest, dict
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.notebooks_v1.services.managed_notebook_service.pagers.ListRuntimesAsyncPager
)
Lists Runtimes in a given project and location.
google.cloud.notebooks_v1.services.managed_notebook_service.ManagedNotebookServiceAsyncClient.parse_common_billing_account_path
parse_common_billing_account_path(path: str) -> typing.Dict[str, str]
Parse a billing_account path into its component segments.
google.cloud.notebooks_v1.services.managed_notebook_service.ManagedNotebookServiceAsyncClient.parse_common_folder_path
parse_common_folder_path(path: str) -> typing.Dict[str, str]
Parse a folder path into its component segments.
google.cloud.notebooks_v1.services.managed_notebook_service.ManagedNotebookServiceAsyncClient.parse_common_location_path
parse_common_location_path(path: str) -> typing.Dict[str, str]
Parse a location path into its component segments.
google.cloud.notebooks_v1.services.managed_notebook_service.ManagedNotebookServiceAsyncClient.parse_common_organization_path
parse_common_organization_path(path: str) -> typing.Dict[str, str]
Parse a organization path into its component segments.
google.cloud.notebooks_v1.services.managed_notebook_service.ManagedNotebookServiceAsyncClient.parse_common_project_path
parse_common_project_path(path: str) -> typing.Dict[str, str]
Parse a project path into its component segments.
google.cloud.notebooks_v1.services.managed_notebook_service.ManagedNotebookServiceAsyncClient.parse_runtime_path
parse_runtime_path(path: str) -> typing.Dict[str, str]
Parses a runtime path into its component segments.
google.cloud.notebooks_v1.services.managed_notebook_service.ManagedNotebookServiceAsyncClient.refresh_runtime_token_internal
refresh_runtime_token_internal(
request: typing.Optional[
typing.Union[
google.cloud.notebooks_v1.types.managed_service.RefreshRuntimeTokenInternalRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
vm_id: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.notebooks_v1.types.managed_service.RefreshRuntimeTokenInternalResponse
)
Gets an access token for the consumer service account that the customer attached to the runtime.
google.cloud.notebooks_v1.services.managed_notebook_service.ManagedNotebookServiceAsyncClient.report_runtime_event
report_runtime_event(
request: typing.Optional[
typing.Union[
google.cloud.notebooks_v1.types.managed_service.ReportRuntimeEventRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Report and process a runtime event.
google.cloud.notebooks_v1.services.managed_notebook_service.ManagedNotebookServiceAsyncClient.reset_runtime
reset_runtime(
request: typing.Optional[
typing.Union[
google.cloud.notebooks_v1.types.managed_service.ResetRuntimeRequest, dict
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Resets a Managed Notebook Runtime.
google.cloud.notebooks_v1.services.managed_notebook_service.ManagedNotebookServiceAsyncClient.runtime_path
runtime_path(project: str, location: str, runtime: str) -> str
Returns a fully-qualified runtime string.
google.cloud.notebooks_v1.services.managed_notebook_service.ManagedNotebookServiceAsyncClient.set_iam_policy
set_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Sets the IAM access control policy on the specified function.
google.cloud.notebooks_v1.services.managed_notebook_service.ManagedNotebookServiceAsyncClient.start_runtime
start_runtime(
request: typing.Optional[
typing.Union[
google.cloud.notebooks_v1.types.managed_service.StartRuntimeRequest, dict
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Starts a Managed Notebook Runtime.
google.cloud.notebooks_v1.services.managed_notebook_service.ManagedNotebookServiceAsyncClient.stop_runtime
stop_runtime(
request: typing.Optional[
typing.Union[
google.cloud.notebooks_v1.types.managed_service.StopRuntimeRequest, dict
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Stops a Managed Notebook Runtime.
google.cloud.notebooks_v1.services.managed_notebook_service.ManagedNotebookServiceAsyncClient.switch_runtime
switch_runtime(
request: typing.Optional[
typing.Union[
google.cloud.notebooks_v1.types.managed_service.SwitchRuntimeRequest, dict
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Switch a Managed Notebook Runtime.
google.cloud.notebooks_v1.services.managed_notebook_service.ManagedNotebookServiceAsyncClient.test_iam_permissions
test_iam_permissions(
request: typing.Optional[
google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.iam_policy_pb2.TestIamPermissionsResponse
Tests the specified IAM permissions against the IAM access control policy for a function.
google.cloud.notebooks_v1.services.managed_notebook_service.ManagedNotebookServiceAsyncClient.update_runtime
update_runtime(
request: typing.Optional[
typing.Union[
google.cloud.notebooks_v1.types.managed_service.UpdateRuntimeRequest, dict
]
] = None,
*,
runtime: typing.Optional[google.cloud.notebooks_v1.types.runtime.Runtime] = None,
update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Update Notebook Runtime configuration.
google.cloud.notebooks_v1.services.managed_notebook_service.ManagedNotebookServiceAsyncClient.upgrade_runtime
upgrade_runtime(
request: typing.Optional[
typing.Union[
google.cloud.notebooks_v1.types.managed_service.UpgradeRuntimeRequest, dict
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Upgrades a Managed Notebook Runtime to the latest version.
google.cloud.notebooks_v1.services.managed_notebook_service.ManagedNotebookServiceClient
ManagedNotebookServiceClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.notebooks_v1.services.managed_notebook_service.transports.base.ManagedNotebookServiceTransport, typing.Callable[[...], google.cloud.notebooks_v1.services.managed_notebook_service.transports.base.ManagedNotebookServiceTransport]]] = 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 managed notebook service client.
See more: google.cloud.notebooks_v1.services.managed_notebook_service.ManagedNotebookServiceClient
google.cloud.notebooks_v1.services.managed_notebook_service.ManagedNotebookServiceClient.__exit__
__exit__(type, value, traceback)
Releases underlying transport's resources.
See more: google.cloud.notebooks_v1.services.managed_notebook_service.ManagedNotebookServiceClient.exit
google.cloud.notebooks_v1.services.managed_notebook_service.ManagedNotebookServiceClient.cancel_operation
cancel_operation(
request: typing.Optional[
google.longrunning.operations_pb2.CancelOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Starts asynchronous cancellation on a long-running operation.
google.cloud.notebooks_v1.services.managed_notebook_service.ManagedNotebookServiceClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
google.cloud.notebooks_v1.services.managed_notebook_service.ManagedNotebookServiceClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
google.cloud.notebooks_v1.services.managed_notebook_service.ManagedNotebookServiceClient.common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
google.cloud.notebooks_v1.services.managed_notebook_service.ManagedNotebookServiceClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
google.cloud.notebooks_v1.services.managed_notebook_service.ManagedNotebookServiceClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
google.cloud.notebooks_v1.services.managed_notebook_service.ManagedNotebookServiceClient.create_runtime
create_runtime(
request: typing.Optional[
typing.Union[
google.cloud.notebooks_v1.types.managed_service.CreateRuntimeRequest, dict
]
] = None,
*,
parent: typing.Optional[str] = None,
runtime_id: typing.Optional[str] = None,
runtime: typing.Optional[google.cloud.notebooks_v1.types.runtime.Runtime] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Creates a new Runtime in a given project and location.
google.cloud.notebooks_v1.services.managed_notebook_service.ManagedNotebookServiceClient.delete_operation
delete_operation(
request: typing.Optional[
google.longrunning.operations_pb2.DeleteOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Deletes a long-running operation.
google.cloud.notebooks_v1.services.managed_notebook_service.ManagedNotebookServiceClient.delete_runtime
delete_runtime(
request: typing.Optional[
typing.Union[
google.cloud.notebooks_v1.types.managed_service.DeleteRuntimeRequest, dict
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Deletes a single Runtime.
google.cloud.notebooks_v1.services.managed_notebook_service.ManagedNotebookServiceClient.diagnose_runtime
diagnose_runtime(
request: typing.Optional[
typing.Union[
google.cloud.notebooks_v1.types.managed_service.DiagnoseRuntimeRequest, dict
]
] = None,
*,
name: typing.Optional[str] = None,
diagnostic_config: typing.Optional[
google.cloud.notebooks_v1.types.diagnostic_config.DiagnosticConfig
] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Creates a Diagnostic File and runs Diagnostic Tool given a Runtime.
google.cloud.notebooks_v1.services.managed_notebook_service.ManagedNotebookServiceClient.from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.notebooks_v1.services.managed_notebook_service.ManagedNotebookServiceClient.from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)
Creates an instance of this client using the provided credentials info.
google.cloud.notebooks_v1.services.managed_notebook_service.ManagedNotebookServiceClient.from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.notebooks_v1.services.managed_notebook_service.ManagedNotebookServiceClient.get_iam_policy
get_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Gets the IAM access control policy for a function.
google.cloud.notebooks_v1.services.managed_notebook_service.ManagedNotebookServiceClient.get_location
get_location(
request: typing.Optional[
google.cloud.location.locations_pb2.GetLocationRequest
] = 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.location.locations_pb2.Location
Gets information about a location.
google.cloud.notebooks_v1.services.managed_notebook_service.ManagedNotebookServiceClient.get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: typing.Optional[
google.api_core.client_options.ClientOptions
] = None,
)
Deprecated.
google.cloud.notebooks_v1.services.managed_notebook_service.ManagedNotebookServiceClient.get_operation
get_operation(
request: typing.Optional[
google.longrunning.operations_pb2.GetOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Gets the latest state of a long-running operation.
google.cloud.notebooks_v1.services.managed_notebook_service.ManagedNotebookServiceClient.get_runtime
get_runtime(
request: typing.Optional[
typing.Union[
google.cloud.notebooks_v1.types.managed_service.GetRuntimeRequest, 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.notebooks_v1.types.runtime.Runtime
Gets details of a single Runtime.
See more: google.cloud.notebooks_v1.services.managed_notebook_service.ManagedNotebookServiceClient.get_runtime
google.cloud.notebooks_v1.services.managed_notebook_service.ManagedNotebookServiceClient.list_locations
list_locations(
request: typing.Optional[
google.cloud.location.locations_pb2.ListLocationsRequest
] = 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.location.locations_pb2.ListLocationsResponse
Lists information about the supported locations for this service.
google.cloud.notebooks_v1.services.managed_notebook_service.ManagedNotebookServiceClient.list_operations
list_operations(
request: typing.Optional[
google.longrunning.operations_pb2.ListOperationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse
Lists operations that match the specified filter in the request.
google.cloud.notebooks_v1.services.managed_notebook_service.ManagedNotebookServiceClient.list_runtimes
list_runtimes(
request: typing.Optional[
typing.Union[
google.cloud.notebooks_v1.types.managed_service.ListRuntimesRequest, dict
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.notebooks_v1.services.managed_notebook_service.pagers.ListRuntimesPager
)
Lists Runtimes in a given project and location.
google.cloud.notebooks_v1.services.managed_notebook_service.ManagedNotebookServiceClient.parse_common_billing_account_path
parse_common_billing_account_path(path: str) -> typing.Dict[str, str]
Parse a billing_account path into its component segments.
google.cloud.notebooks_v1.services.managed_notebook_service.ManagedNotebookServiceClient.parse_common_folder_path
parse_common_folder_path(path: str) -> typing.Dict[str, str]
Parse a folder path into its component segments.
google.cloud.notebooks_v1.services.managed_notebook_service.ManagedNotebookServiceClient.parse_common_location_path
parse_common_location_path(path: str) -> typing.Dict[str, str]
Parse a location path into its component segments.
google.cloud.notebooks_v1.services.managed_notebook_service.ManagedNotebookServiceClient.parse_common_organization_path
parse_common_organization_path(path: str) -> typing.Dict[str, str]
Parse a organization path into its component segments.
google.cloud.notebooks_v1.services.managed_notebook_service.ManagedNotebookServiceClient.parse_common_project_path
parse_common_project_path(path: str) -> typing.Dict[str, str]
Parse a project path into its component segments.
google.cloud.notebooks_v1.services.managed_notebook_service.ManagedNotebookServiceClient.parse_runtime_path
parse_runtime_path(path: str) -> typing.Dict[str, str]
Parses a runtime path into its component segments.
google.cloud.notebooks_v1.services.managed_notebook_service.ManagedNotebookServiceClient.refresh_runtime_token_internal
refresh_runtime_token_internal(
request: typing.Optional[
typing.Union[
google.cloud.notebooks_v1.types.managed_service.RefreshRuntimeTokenInternalRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
vm_id: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.notebooks_v1.types.managed_service.RefreshRuntimeTokenInternalResponse
)
Gets an access token for the consumer service account that the customer attached to the runtime.
google.cloud.notebooks_v1.services.managed_notebook_service.ManagedNotebookServiceClient.report_runtime_event
report_runtime_event(
request: typing.Optional[
typing.Union[
google.cloud.notebooks_v1.types.managed_service.ReportRuntimeEventRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Report and process a runtime event.
google.cloud.notebooks_v1.services.managed_notebook_service.ManagedNotebookServiceClient.reset_runtime
reset_runtime(
request: typing.Optional[
typing.Union[
google.cloud.notebooks_v1.types.managed_service.ResetRuntimeRequest, dict
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Resets a Managed Notebook Runtime.
google.cloud.notebooks_v1.services.managed_notebook_service.ManagedNotebookServiceClient.runtime_path
runtime_path(project: str, location: str, runtime: str) -> str
Returns a fully-qualified runtime string.
google.cloud.notebooks_v1.services.managed_notebook_service.ManagedNotebookServiceClient.set_iam_policy
set_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Sets the IAM access control policy on the specified function.
google.cloud.notebooks_v1.services.managed_notebook_service.ManagedNotebookServiceClient.start_runtime
start_runtime(
request: typing.Optional[
typing.Union[
google.cloud.notebooks_v1.types.managed_service.StartRuntimeRequest, dict
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Starts a Managed Notebook Runtime.
google.cloud.notebooks_v1.services.managed_notebook_service.ManagedNotebookServiceClient.stop_runtime
stop_runtime(
request: typing.Optional[
typing.Union[
google.cloud.notebooks_v1.types.managed_service.StopRuntimeRequest, dict
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Stops a Managed Notebook Runtime.
google.cloud.notebooks_v1.services.managed_notebook_service.ManagedNotebookServiceClient.switch_runtime
switch_runtime(
request: typing.Optional[
typing.Union[
google.cloud.notebooks_v1.types.managed_service.SwitchRuntimeRequest, dict
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Switch a Managed Notebook Runtime.
google.cloud.notebooks_v1.services.managed_notebook_service.ManagedNotebookServiceClient.test_iam_permissions
test_iam_permissions(
request: typing.Optional[
google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.iam_policy_pb2.TestIamPermissionsResponse
Tests the specified IAM permissions against the IAM access control policy for a function.
google.cloud.notebooks_v1.services.managed_notebook_service.ManagedNotebookServiceClient.update_runtime
update_runtime(
request: typing.Optional[
typing.Union[
google.cloud.notebooks_v1.types.managed_service.UpdateRuntimeRequest, dict
]
] = None,
*,
runtime: typing.Optional[google.cloud.notebooks_v1.types.runtime.Runtime] = None,
update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Update Notebook Runtime configuration.
google.cloud.notebooks_v1.services.managed_notebook_service.ManagedNotebookServiceClient.upgrade_runtime
upgrade_runtime(
request: typing.Optional[
typing.Union[
google.cloud.notebooks_v1.types.managed_service.UpgradeRuntimeRequest, dict
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Upgrades a Managed Notebook Runtime to the latest version.
google.cloud.notebooks_v1.services.managed_notebook_service.pagers.ListRuntimesAsyncPager
ListRuntimesAsyncPager(
method: typing.Callable[
[...],
typing.Awaitable[
google.cloud.notebooks_v1.types.managed_service.ListRuntimesResponse
],
],
request: google.cloud.notebooks_v1.types.managed_service.ListRuntimesRequest,
response: google.cloud.notebooks_v1.types.managed_service.ListRuntimesResponse,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiates the pager.
See more: google.cloud.notebooks_v1.services.managed_notebook_service.pagers.ListRuntimesAsyncPager
google.cloud.notebooks_v1.services.managed_notebook_service.pagers.ListRuntimesPager
ListRuntimesPager(
method: typing.Callable[
[...], google.cloud.notebooks_v1.types.managed_service.ListRuntimesResponse
],
request: google.cloud.notebooks_v1.types.managed_service.ListRuntimesRequest,
response: google.cloud.notebooks_v1.types.managed_service.ListRuntimesResponse,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiate the pager.
See more: google.cloud.notebooks_v1.services.managed_notebook_service.pagers.ListRuntimesPager
google.cloud.notebooks_v1.services.notebook_service.NotebookServiceAsyncClient
NotebookServiceAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.notebooks_v1.services.notebook_service.transports.base.NotebookServiceTransport, typing.Callable[[...], google.cloud.notebooks_v1.services.notebook_service.transports.base.NotebookServiceTransport]]] = '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 notebook service async client.
See more: google.cloud.notebooks_v1.services.notebook_service.NotebookServiceAsyncClient
google.cloud.notebooks_v1.services.notebook_service.NotebookServiceAsyncClient.cancel_operation
cancel_operation(
request: typing.Optional[
google.longrunning.operations_pb2.CancelOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Starts asynchronous cancellation on a long-running operation.
See more: google.cloud.notebooks_v1.services.notebook_service.NotebookServiceAsyncClient.cancel_operation
google.cloud.notebooks_v1.services.notebook_service.NotebookServiceAsyncClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
google.cloud.notebooks_v1.services.notebook_service.NotebookServiceAsyncClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
See more: google.cloud.notebooks_v1.services.notebook_service.NotebookServiceAsyncClient.common_folder_path
google.cloud.notebooks_v1.services.notebook_service.NotebookServiceAsyncClient.common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
See more: google.cloud.notebooks_v1.services.notebook_service.NotebookServiceAsyncClient.common_location_path
google.cloud.notebooks_v1.services.notebook_service.NotebookServiceAsyncClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
google.cloud.notebooks_v1.services.notebook_service.NotebookServiceAsyncClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
See more: google.cloud.notebooks_v1.services.notebook_service.NotebookServiceAsyncClient.common_project_path
google.cloud.notebooks_v1.services.notebook_service.NotebookServiceAsyncClient.create_environment
create_environment(
request: typing.Optional[
typing.Union[
google.cloud.notebooks_v1.types.service.CreateEnvironmentRequest, dict
]
] = None,
*,
parent: typing.Optional[str] = None,
environment: typing.Optional[
google.cloud.notebooks_v1.types.environment.Environment
] = None,
environment_id: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Creates a new Environment.
See more: google.cloud.notebooks_v1.services.notebook_service.NotebookServiceAsyncClient.create_environment
google.cloud.notebooks_v1.services.notebook_service.NotebookServiceAsyncClient.create_execution
create_execution(
request: typing.Optional[
typing.Union[
google.cloud.notebooks_v1.types.service.CreateExecutionRequest, dict
]
] = None,
*,
parent: typing.Optional[str] = None,
execution: typing.Optional[
google.cloud.notebooks_v1.types.execution.Execution
] = None,
execution_id: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Creates a new Execution in a given project and location.
See more: google.cloud.notebooks_v1.services.notebook_service.NotebookServiceAsyncClient.create_execution
google.cloud.notebooks_v1.services.notebook_service.NotebookServiceAsyncClient.create_instance
create_instance(
request: typing.Optional[
typing.Union[
google.cloud.notebooks_v1.types.service.CreateInstanceRequest, dict
]
] = None,
*,
parent: typing.Optional[str] = None,
instance: typing.Optional[google.cloud.notebooks_v1.types.instance.Instance] = None,
instance_id: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Creates a new Instance in a given project and location.
See more: google.cloud.notebooks_v1.services.notebook_service.NotebookServiceAsyncClient.create_instance
google.cloud.notebooks_v1.services.notebook_service.NotebookServiceAsyncClient.create_schedule
create_schedule(
request: typing.Optional[
typing.Union[
google.cloud.notebooks_v1.types.service.CreateScheduleRequest, dict
]
] = None,
*,
parent: typing.Optional[str] = None,
schedule: typing.Optional[google.cloud.notebooks_v1.types.schedule.Schedule] = None,
schedule_id: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Creates a new Scheduled Notebook in a given project and location.
See more: google.cloud.notebooks_v1.services.notebook_service.NotebookServiceAsyncClient.create_schedule
google.cloud.notebooks_v1.services.notebook_service.NotebookServiceAsyncClient.delete_environment
delete_environment(
request: typing.Optional[
typing.Union[
google.cloud.notebooks_v1.types.service.DeleteEnvironmentRequest, dict
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Deletes a single Environment.
See more: google.cloud.notebooks_v1.services.notebook_service.NotebookServiceAsyncClient.delete_environment
google.cloud.notebooks_v1.services.notebook_service.NotebookServiceAsyncClient.delete_execution
delete_execution(
request: typing.Optional[
typing.Union[
google.cloud.notebooks_v1.types.service.DeleteExecutionRequest, dict
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Deletes execution.
See more: google.cloud.notebooks_v1.services.notebook_service.NotebookServiceAsyncClient.delete_execution
google.cloud.notebooks_v1.services.notebook_service.NotebookServiceAsyncClient.delete_instance
delete_instance(
request: typing.Optional[
typing.Union[
google.cloud.notebooks_v1.types.service.DeleteInstanceRequest, dict
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Deletes a single Instance.
See more: google.cloud.notebooks_v1.services.notebook_service.NotebookServiceAsyncClient.delete_instance
google.cloud.notebooks_v1.services.notebook_service.NotebookServiceAsyncClient.delete_operation
delete_operation(
request: typing.Optional[
google.longrunning.operations_pb2.DeleteOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Deletes a long-running operation.
See more: google.cloud.notebooks_v1.services.notebook_service.NotebookServiceAsyncClient.delete_operation
google.cloud.notebooks_v1.services.notebook_service.NotebookServiceAsyncClient.delete_schedule
delete_schedule(
request: typing.Optional[
typing.Union[
google.cloud.notebooks_v1.types.service.DeleteScheduleRequest, dict
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Deletes schedule and all underlying jobs.
See more: google.cloud.notebooks_v1.services.notebook_service.NotebookServiceAsyncClient.delete_schedule
google.cloud.notebooks_v1.services.notebook_service.NotebookServiceAsyncClient.diagnose_instance
diagnose_instance(
request: typing.Optional[
typing.Union[
google.cloud.notebooks_v1.types.service.DiagnoseInstanceRequest, dict
]
] = None,
*,
name: typing.Optional[str] = None,
diagnostic_config: typing.Optional[
google.cloud.notebooks_v1.types.diagnostic_config.DiagnosticConfig
] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Creates a Diagnostic File and runs Diagnostic Tool given an Instance.
See more: google.cloud.notebooks_v1.services.notebook_service.NotebookServiceAsyncClient.diagnose_instance
google.cloud.notebooks_v1.services.notebook_service.NotebookServiceAsyncClient.environment_path
environment_path(project: str, environment: str) -> str
Returns a fully-qualified environment string.
See more: google.cloud.notebooks_v1.services.notebook_service.NotebookServiceAsyncClient.environment_path
google.cloud.notebooks_v1.services.notebook_service.NotebookServiceAsyncClient.execution_path
execution_path(project: str, location: str, execution: str) -> str
Returns a fully-qualified execution string.
See more: google.cloud.notebooks_v1.services.notebook_service.NotebookServiceAsyncClient.execution_path
google.cloud.notebooks_v1.services.notebook_service.NotebookServiceAsyncClient.from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.notebooks_v1.services.notebook_service.NotebookServiceAsyncClient.from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)
Creates an instance of this client using the provided credentials info.
google.cloud.notebooks_v1.services.notebook_service.NotebookServiceAsyncClient.from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.notebooks_v1.services.notebook_service.NotebookServiceAsyncClient.get_environment
get_environment(
request: typing.Optional[
typing.Union[
google.cloud.notebooks_v1.types.service.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.notebooks_v1.types.environment.Environment
Gets details of a single Environment.
See more: google.cloud.notebooks_v1.services.notebook_service.NotebookServiceAsyncClient.get_environment
google.cloud.notebooks_v1.services.notebook_service.NotebookServiceAsyncClient.get_execution
get_execution(
request: typing.Optional[
typing.Union[google.cloud.notebooks_v1.types.service.GetExecutionRequest, 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.notebooks_v1.types.execution.Execution
Gets details of executions.
See more: google.cloud.notebooks_v1.services.notebook_service.NotebookServiceAsyncClient.get_execution
google.cloud.notebooks_v1.services.notebook_service.NotebookServiceAsyncClient.get_iam_policy
get_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Gets the IAM access control policy for a function.
See more: google.cloud.notebooks_v1.services.notebook_service.NotebookServiceAsyncClient.get_iam_policy
google.cloud.notebooks_v1.services.notebook_service.NotebookServiceAsyncClient.get_instance
get_instance(
request: typing.Optional[
typing.Union[google.cloud.notebooks_v1.types.service.GetInstanceRequest, 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.notebooks_v1.types.instance.Instance
Gets details of a single Instance.
See more: google.cloud.notebooks_v1.services.notebook_service.NotebookServiceAsyncClient.get_instance
google.cloud.notebooks_v1.services.notebook_service.NotebookServiceAsyncClient.get_instance_health
get_instance_health(
request: typing.Optional[
typing.Union[
google.cloud.notebooks_v1.types.service.GetInstanceHealthRequest, 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.notebooks_v1.types.service.GetInstanceHealthResponse
Check if a notebook instance is healthy.
See more: google.cloud.notebooks_v1.services.notebook_service.NotebookServiceAsyncClient.get_instance_health
google.cloud.notebooks_v1.services.notebook_service.NotebookServiceAsyncClient.get_location
get_location(
request: typing.Optional[
google.cloud.location.locations_pb2.GetLocationRequest
] = 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.location.locations_pb2.Location
Gets information about a location.
See more: google.cloud.notebooks_v1.services.notebook_service.NotebookServiceAsyncClient.get_location
google.cloud.notebooks_v1.services.notebook_service.NotebookServiceAsyncClient.get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: typing.Optional[
google.api_core.client_options.ClientOptions
] = None,
)
Return the API endpoint and client cert source for mutual TLS.
google.cloud.notebooks_v1.services.notebook_service.NotebookServiceAsyncClient.get_operation
get_operation(
request: typing.Optional[
google.longrunning.operations_pb2.GetOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Gets the latest state of a long-running operation.
See more: google.cloud.notebooks_v1.services.notebook_service.NotebookServiceAsyncClient.get_operation
google.cloud.notebooks_v1.services.notebook_service.NotebookServiceAsyncClient.get_schedule
get_schedule(
request: typing.Optional[
typing.Union[google.cloud.notebooks_v1.types.service.GetScheduleRequest, 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.notebooks_v1.types.schedule.Schedule
Gets details of schedule.
See more: google.cloud.notebooks_v1.services.notebook_service.NotebookServiceAsyncClient.get_schedule
google.cloud.notebooks_v1.services.notebook_service.NotebookServiceAsyncClient.get_transport_class
get_transport_class() -> (
typing.Type[
google.cloud.notebooks_v1.services.notebook_service.transports.base.NotebookServiceTransport
]
)
Returns an appropriate transport class.
See more: google.cloud.notebooks_v1.services.notebook_service.NotebookServiceAsyncClient.get_transport_class
google.cloud.notebooks_v1.services.notebook_service.NotebookServiceAsyncClient.instance_path
instance_path(project: str, instance: str) -> str
Returns a fully-qualified instance string.
See more: google.cloud.notebooks_v1.services.notebook_service.NotebookServiceAsyncClient.instance_path
google.cloud.notebooks_v1.services.notebook_service.NotebookServiceAsyncClient.is_instance_upgradeable
is_instance_upgradeable(
request: typing.Optional[
typing.Union[
google.cloud.notebooks_v1.types.service.IsInstanceUpgradeableRequest, 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.cloud.notebooks_v1.types.service.IsInstanceUpgradeableResponse
Check if a notebook instance is upgradable.
google.cloud.notebooks_v1.services.notebook_service.NotebookServiceAsyncClient.list_environments
list_environments(
request: typing.Optional[
typing.Union[
google.cloud.notebooks_v1.types.service.ListEnvironmentsRequest, dict
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.notebooks_v1.services.notebook_service.pagers.ListEnvironmentsAsyncPager
)
Lists environments in a project.
See more: google.cloud.notebooks_v1.services.notebook_service.NotebookServiceAsyncClient.list_environments
google.cloud.notebooks_v1.services.notebook_service.NotebookServiceAsyncClient.list_executions
list_executions(
request: typing.Optional[
typing.Union[
google.cloud.notebooks_v1.types.service.ListExecutionsRequest, dict
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.notebooks_v1.services.notebook_service.pagers.ListExecutionsAsyncPager
)
Lists executions in a given project and location.
See more: google.cloud.notebooks_v1.services.notebook_service.NotebookServiceAsyncClient.list_executions
google.cloud.notebooks_v1.services.notebook_service.NotebookServiceAsyncClient.list_instances
list_instances(
request: typing.Optional[
typing.Union[google.cloud.notebooks_v1.types.service.ListInstancesRequest, dict]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.notebooks_v1.services.notebook_service.pagers.ListInstancesAsyncPager
Lists instances in a given project and location.
See more: google.cloud.notebooks_v1.services.notebook_service.NotebookServiceAsyncClient.list_instances
google.cloud.notebooks_v1.services.notebook_service.NotebookServiceAsyncClient.list_locations
list_locations(
request: typing.Optional[
google.cloud.location.locations_pb2.ListLocationsRequest
] = 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.location.locations_pb2.ListLocationsResponse
Lists information about the supported locations for this service.
See more: google.cloud.notebooks_v1.services.notebook_service.NotebookServiceAsyncClient.list_locations
google.cloud.notebooks_v1.services.notebook_service.NotebookServiceAsyncClient.list_operations
list_operations(
request: typing.Optional[
google.longrunning.operations_pb2.ListOperationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse
Lists operations that match the specified filter in the request.
See more: google.cloud.notebooks_v1.services.notebook_service.NotebookServiceAsyncClient.list_operations
google.cloud.notebooks_v1.services.notebook_service.NotebookServiceAsyncClient.list_schedules
list_schedules(
request: typing.Optional[
typing.Union[google.cloud.notebooks_v1.types.service.ListSchedulesRequest, dict]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.notebooks_v1.services.notebook_service.pagers.ListSchedulesAsyncPager
Lists schedules in a given project and location.
See more: google.cloud.notebooks_v1.services.notebook_service.NotebookServiceAsyncClient.list_schedules
google.cloud.notebooks_v1.services.notebook_service.NotebookServiceAsyncClient.parse_common_billing_account_path
parse_common_billing_account_path(path: str) -> typing.Dict[str, str]
Parse a billing_account path into its component segments.
google.cloud.notebooks_v1.services.notebook_service.NotebookServiceAsyncClient.parse_common_folder_path
parse_common_folder_path(path: str) -> typing.Dict[str, str]
Parse a folder path into its component segments.
google.cloud.notebooks_v1.services.notebook_service.NotebookServiceAsyncClient.parse_common_location_path
parse_common_location_path(path: str) -> typing.Dict[str, str]
Parse a location path into its component segments.
google.cloud.notebooks_v1.services.notebook_service.NotebookServiceAsyncClient.parse_common_organization_path
parse_common_organization_path(path: str) -> typing.Dict[str, str]
Parse a organization path into its component segments.
google.cloud.notebooks_v1.services.notebook_service.NotebookServiceAsyncClient.parse_common_project_path
parse_common_project_path(path: str) -> typing.Dict[str, str]
Parse a project path into its component segments.
google.cloud.notebooks_v1.services.notebook_service.NotebookServiceAsyncClient.parse_environment_path
parse_environment_path(path: str) -> typing.Dict[str, str]
Parses a environment path into its component segments.
google.cloud.notebooks_v1.services.notebook_service.NotebookServiceAsyncClient.parse_execution_path
parse_execution_path(path: str) -> typing.Dict[str, str]
Parses a execution path into its component segments.
See more: google.cloud.notebooks_v1.services.notebook_service.NotebookServiceAsyncClient.parse_execution_path
google.cloud.notebooks_v1.services.notebook_service.NotebookServiceAsyncClient.parse_instance_path
parse_instance_path(path: str) -> typing.Dict[str, str]
Parses a instance path into its component segments.
See more: google.cloud.notebooks_v1.services.notebook_service.NotebookServiceAsyncClient.parse_instance_path
google.cloud.notebooks_v1.services.notebook_service.NotebookServiceAsyncClient.parse_schedule_path
parse_schedule_path(path: str) -> typing.Dict[str, str]
Parses a schedule path into its component segments.
See more: google.cloud.notebooks_v1.services.notebook_service.NotebookServiceAsyncClient.parse_schedule_path
google.cloud.notebooks_v1.services.notebook_service.NotebookServiceAsyncClient.parse_tensorboard_path
parse_tensorboard_path(path: str) -> typing.Dict[str, str]
Parses a tensorboard path into its component segments.
google.cloud.notebooks_v1.services.notebook_service.NotebookServiceAsyncClient.register_instance
register_instance(
request: typing.Optional[
typing.Union[
google.cloud.notebooks_v1.types.service.RegisterInstanceRequest, 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
Registers an existing legacy notebook instance to the Notebooks API server.
See more: google.cloud.notebooks_v1.services.notebook_service.NotebookServiceAsyncClient.register_instance
google.cloud.notebooks_v1.services.notebook_service.NotebookServiceAsyncClient.report_instance_info
report_instance_info(
request: typing.Optional[
typing.Union[
google.cloud.notebooks_v1.types.service.ReportInstanceInfoRequest, 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
Allows notebook instances to report their latest instance information to the Notebooks API server.
See more: google.cloud.notebooks_v1.services.notebook_service.NotebookServiceAsyncClient.report_instance_info
google.cloud.notebooks_v1.services.notebook_service.NotebookServiceAsyncClient.reset_instance
reset_instance(
request: typing.Optional[
typing.Union[google.cloud.notebooks_v1.types.service.ResetInstanceRequest, 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
Resets a notebook instance.
See more: google.cloud.notebooks_v1.services.notebook_service.NotebookServiceAsyncClient.reset_instance
google.cloud.notebooks_v1.services.notebook_service.NotebookServiceAsyncClient.rollback_instance
rollback_instance(
request: typing.Optional[
typing.Union[
google.cloud.notebooks_v1.types.service.RollbackInstanceRequest, 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
Rollbacks a notebook instance to the previous version.
See more: google.cloud.notebooks_v1.services.notebook_service.NotebookServiceAsyncClient.rollback_instance
google.cloud.notebooks_v1.services.notebook_service.NotebookServiceAsyncClient.schedule_path
schedule_path(project: str, location: str, schedule: str) -> str
Returns a fully-qualified schedule string.
See more: google.cloud.notebooks_v1.services.notebook_service.NotebookServiceAsyncClient.schedule_path
google.cloud.notebooks_v1.services.notebook_service.NotebookServiceAsyncClient.set_iam_policy
set_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Sets the IAM access control policy on the specified function.
See more: google.cloud.notebooks_v1.services.notebook_service.NotebookServiceAsyncClient.set_iam_policy
google.cloud.notebooks_v1.services.notebook_service.NotebookServiceAsyncClient.set_instance_accelerator
set_instance_accelerator(
request: typing.Optional[
typing.Union[
google.cloud.notebooks_v1.types.service.SetInstanceAcceleratorRequest, 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
Updates the guest accelerators of a single Instance.
google.cloud.notebooks_v1.services.notebook_service.NotebookServiceAsyncClient.set_instance_labels
set_instance_labels(
request: typing.Optional[
typing.Union[
google.cloud.notebooks_v1.types.service.SetInstanceLabelsRequest, 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
Replaces all the labels of an Instance.
See more: google.cloud.notebooks_v1.services.notebook_service.NotebookServiceAsyncClient.set_instance_labels
google.cloud.notebooks_v1.services.notebook_service.NotebookServiceAsyncClient.set_instance_machine_type
set_instance_machine_type(
request: typing.Optional[
typing.Union[
google.cloud.notebooks_v1.types.service.SetInstanceMachineTypeRequest, 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
Updates the machine type of a single Instance.
google.cloud.notebooks_v1.services.notebook_service.NotebookServiceAsyncClient.start_instance
start_instance(
request: typing.Optional[
typing.Union[google.cloud.notebooks_v1.types.service.StartInstanceRequest, 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 a notebook instance.
See more: google.cloud.notebooks_v1.services.notebook_service.NotebookServiceAsyncClient.start_instance
google.cloud.notebooks_v1.services.notebook_service.NotebookServiceAsyncClient.stop_instance
stop_instance(
request: typing.Optional[
typing.Union[google.cloud.notebooks_v1.types.service.StopInstanceRequest, 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
Stops a notebook instance.
See more: google.cloud.notebooks_v1.services.notebook_service.NotebookServiceAsyncClient.stop_instance
google.cloud.notebooks_v1.services.notebook_service.NotebookServiceAsyncClient.tensorboard_path
tensorboard_path(project: str, location: str, tensorboard: str) -> str
Returns a fully-qualified tensorboard string.
See more: google.cloud.notebooks_v1.services.notebook_service.NotebookServiceAsyncClient.tensorboard_path
google.cloud.notebooks_v1.services.notebook_service.NotebookServiceAsyncClient.test_iam_permissions
test_iam_permissions(
request: typing.Optional[
google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.iam_policy_pb2.TestIamPermissionsResponse
Tests the specified IAM permissions against the IAM access control policy for a function.
See more: google.cloud.notebooks_v1.services.notebook_service.NotebookServiceAsyncClient.test_iam_permissions
google.cloud.notebooks_v1.services.notebook_service.NotebookServiceAsyncClient.trigger_schedule
trigger_schedule(
request: typing.Optional[
typing.Union[
google.cloud.notebooks_v1.types.service.TriggerScheduleRequest, 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
Triggers execution of an existing schedule.
See more: google.cloud.notebooks_v1.services.notebook_service.NotebookServiceAsyncClient.trigger_schedule
google.cloud.notebooks_v1.services.notebook_service.NotebookServiceAsyncClient.update_instance_config
update_instance_config(
request: typing.Optional[
typing.Union[
google.cloud.notebooks_v1.types.service.UpdateInstanceConfigRequest, 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
Update Notebook Instance configurations.
google.cloud.notebooks_v1.services.notebook_service.NotebookServiceAsyncClient.update_instance_metadata_items
update_instance_metadata_items(
request: typing.Optional[
typing.Union[
google.cloud.notebooks_v1.types.service.UpdateInstanceMetadataItemsRequest,
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.cloud.notebooks_v1.types.service.UpdateInstanceMetadataItemsResponse
Add/update metadata items for an instance.
google.cloud.notebooks_v1.services.notebook_service.NotebookServiceAsyncClient.update_shielded_instance_config
update_shielded_instance_config(
request: typing.Optional[
typing.Union[
google.cloud.notebooks_v1.types.service.UpdateShieldedInstanceConfigRequest,
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
Updates the Shielded instance configuration of a single Instance.
google.cloud.notebooks_v1.services.notebook_service.NotebookServiceAsyncClient.upgrade_instance
upgrade_instance(
request: typing.Optional[
typing.Union[
google.cloud.notebooks_v1.types.service.UpgradeInstanceRequest, 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
Upgrades a notebook instance to the latest version.
See more: google.cloud.notebooks_v1.services.notebook_service.NotebookServiceAsyncClient.upgrade_instance
google.cloud.notebooks_v1.services.notebook_service.NotebookServiceAsyncClient.upgrade_instance_internal
upgrade_instance_internal(
request: typing.Optional[
typing.Union[
google.cloud.notebooks_v1.types.service.UpgradeInstanceInternalRequest, 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
Allows notebook instances to call this endpoint to upgrade themselves.
google.cloud.notebooks_v1.services.notebook_service.NotebookServiceClient
NotebookServiceClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.notebooks_v1.services.notebook_service.transports.base.NotebookServiceTransport, typing.Callable[[...], google.cloud.notebooks_v1.services.notebook_service.transports.base.NotebookServiceTransport]]] = 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 notebook service client.
See more: google.cloud.notebooks_v1.services.notebook_service.NotebookServiceClient
google.cloud.notebooks_v1.services.notebook_service.NotebookServiceClient.__exit__
__exit__(type, value, traceback)
Releases underlying transport's resources.
See more: google.cloud.notebooks_v1.services.notebook_service.NotebookServiceClient.exit
google.cloud.notebooks_v1.services.notebook_service.NotebookServiceClient.cancel_operation
cancel_operation(
request: typing.Optional[
google.longrunning.operations_pb2.CancelOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Starts asynchronous cancellation on a long-running operation.
See more: google.cloud.notebooks_v1.services.notebook_service.NotebookServiceClient.cancel_operation
google.cloud.notebooks_v1.services.notebook_service.NotebookServiceClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
google.cloud.notebooks_v1.services.notebook_service.NotebookServiceClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
See more: google.cloud.notebooks_v1.services.notebook_service.NotebookServiceClient.common_folder_path
google.cloud.notebooks_v1.services.notebook_service.NotebookServiceClient.common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
See more: google.cloud.notebooks_v1.services.notebook_service.NotebookServiceClient.common_location_path
google.cloud.notebooks_v1.services.notebook_service.NotebookServiceClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
See more: google.cloud.notebooks_v1.services.notebook_service.NotebookServiceClient.common_organization_path
google.cloud.notebooks_v1.services.notebook_service.NotebookServiceClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
See more: google.cloud.notebooks_v1.services.notebook_service.NotebookServiceClient.common_project_path
google.cloud.notebooks_v1.services.notebook_service.NotebookServiceClient.create_environment
create_environment(
request: typing.Optional[
typing.Union[
google.cloud.notebooks_v1.types.service.CreateEnvironmentRequest, dict
]
] = None,
*,
parent: typing.Optional[str] = None,
environment: typing.Optional[
google.cloud.notebooks_v1.types.environment.Environment
] = None,
environment_id: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Creates a new Environment.
See more: google.cloud.notebooks_v1.services.notebook_service.NotebookServiceClient.create_environment
google.cloud.notebooks_v1.services.notebook_service.NotebookServiceClient.create_execution
create_execution(
request: typing.Optional[
typing.Union[
google.cloud.notebooks_v1.types.service.CreateExecutionRequest, dict
]
] = None,
*,
parent: typing.Optional[str] = None,
execution: typing.Optional[
google.cloud.notebooks_v1.types.execution.Execution
] = None,
execution_id: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Creates a new Execution in a given project and location.
See more: google.cloud.notebooks_v1.services.notebook_service.NotebookServiceClient.create_execution
google.cloud.notebooks_v1.services.notebook_service.NotebookServiceClient.create_instance
create_instance(
request: typing.Optional[
typing.Union[
google.cloud.notebooks_v1.types.service.CreateInstanceRequest, dict
]
] = None,
*,
parent: typing.Optional[str] = None,
instance: typing.Optional[google.cloud.notebooks_v1.types.instance.Instance] = None,
instance_id: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Creates a new Instance in a given project and location.
See more: google.cloud.notebooks_v1.services.notebook_service.NotebookServiceClient.create_instance
google.cloud.notebooks_v1.services.notebook_service.NotebookServiceClient.create_schedule
create_schedule(
request: typing.Optional[
typing.Union[
google.cloud.notebooks_v1.types.service.CreateScheduleRequest, dict
]
] = None,
*,
parent: typing.Optional[str] = None,
schedule: typing.Optional[google.cloud.notebooks_v1.types.schedule.Schedule] = None,
schedule_id: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Creates a new Scheduled Notebook in a given project and location.
See more: google.cloud.notebooks_v1.services.notebook_service.NotebookServiceClient.create_schedule
google.cloud.notebooks_v1.services.notebook_service.NotebookServiceClient.delete_environment
delete_environment(
request: typing.Optional[
typing.Union[
google.cloud.notebooks_v1.types.service.DeleteEnvironmentRequest, dict
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Deletes a single Environment.
See more: google.cloud.notebooks_v1.services.notebook_service.NotebookServiceClient.delete_environment
google.cloud.notebooks_v1.services.notebook_service.NotebookServiceClient.delete_execution
delete_execution(
request: typing.Optional[
typing.Union[
google.cloud.notebooks_v1.types.service.DeleteExecutionRequest, dict
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Deletes execution.
See more: google.cloud.notebooks_v1.services.notebook_service.NotebookServiceClient.delete_execution
google.cloud.notebooks_v1.services.notebook_service.NotebookServiceClient.delete_instance
delete_instance(
request: typing.Optional[
typing.Union[
google.cloud.notebooks_v1.types.service.DeleteInstanceRequest, dict
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Deletes a single Instance.
See more: google.cloud.notebooks_v1.services.notebook_service.NotebookServiceClient.delete_instance
google.cloud.notebooks_v1.services.notebook_service.NotebookServiceClient.delete_operation
delete_operation(
request: typing.Optional[
google.longrunning.operations_pb2.DeleteOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Deletes a long-running operation.
See more: google.cloud.notebooks_v1.services.notebook_service.NotebookServiceClient.delete_operation
google.cloud.notebooks_v1.services.notebook_service.NotebookServiceClient.delete_schedule
delete_schedule(
request: typing.Optional[
typing.Union[
google.cloud.notebooks_v1.types.service.DeleteScheduleRequest, dict
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Deletes schedule and all underlying jobs.
See more: google.cloud.notebooks_v1.services.notebook_service.NotebookServiceClient.delete_schedule
google.cloud.notebooks_v1.services.notebook_service.NotebookServiceClient.diagnose_instance
diagnose_instance(
request: typing.Optional[
typing.Union[
google.cloud.notebooks_v1.types.service.DiagnoseInstanceRequest, dict
]
] = None,
*,
name: typing.Optional[str] = None,
diagnostic_config: typing.Optional[
google.cloud.notebooks_v1.types.diagnostic_config.DiagnosticConfig
] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Creates a Diagnostic File and runs Diagnostic Tool given an Instance.
See more: google.cloud.notebooks_v1.services.notebook_service.NotebookServiceClient.diagnose_instance
google.cloud.notebooks_v1.services.notebook_service.NotebookServiceClient.environment_path
environment_path(project: str, environment: str) -> str
Returns a fully-qualified environment string.
See more: google.cloud.notebooks_v1.services.notebook_service.NotebookServiceClient.environment_path
google.cloud.notebooks_v1.services.notebook_service.NotebookServiceClient.execution_path
execution_path(project: str, location: str, execution: str) -> str
Returns a fully-qualified execution string.
See more: google.cloud.notebooks_v1.services.notebook_service.NotebookServiceClient.execution_path
google.cloud.notebooks_v1.services.notebook_service.NotebookServiceClient.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.notebooks_v1.services.notebook_service.NotebookServiceClient.from_service_account_file
google.cloud.notebooks_v1.services.notebook_service.NotebookServiceClient.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.notebooks_v1.services.notebook_service.NotebookServiceClient.from_service_account_info
google.cloud.notebooks_v1.services.notebook_service.NotebookServiceClient.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.notebooks_v1.services.notebook_service.NotebookServiceClient.from_service_account_json
google.cloud.notebooks_v1.services.notebook_service.NotebookServiceClient.get_environment
get_environment(
request: typing.Optional[
typing.Union[
google.cloud.notebooks_v1.types.service.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.notebooks_v1.types.environment.Environment
Gets details of a single Environment.
See more: google.cloud.notebooks_v1.services.notebook_service.NotebookServiceClient.get_environment
google.cloud.notebooks_v1.services.notebook_service.NotebookServiceClient.get_execution
get_execution(
request: typing.Optional[
typing.Union[google.cloud.notebooks_v1.types.service.GetExecutionRequest, 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.notebooks_v1.types.execution.Execution
Gets details of executions.
See more: google.cloud.notebooks_v1.services.notebook_service.NotebookServiceClient.get_execution
google.cloud.notebooks_v1.services.notebook_service.NotebookServiceClient.get_iam_policy
get_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Gets the IAM access control policy for a function.
See more: google.cloud.notebooks_v1.services.notebook_service.NotebookServiceClient.get_iam_policy
google.cloud.notebooks_v1.services.notebook_service.NotebookServiceClient.get_instance
get_instance(
request: typing.Optional[
typing.Union[google.cloud.notebooks_v1.types.service.GetInstanceRequest, 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.notebooks_v1.types.instance.Instance
Gets details of a single Instance.
See more: google.cloud.notebooks_v1.services.notebook_service.NotebookServiceClient.get_instance
google.cloud.notebooks_v1.services.notebook_service.NotebookServiceClient.get_instance_health
get_instance_health(
request: typing.Optional[
typing.Union[
google.cloud.notebooks_v1.types.service.GetInstanceHealthRequest, 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.notebooks_v1.types.service.GetInstanceHealthResponse
Check if a notebook instance is healthy.
See more: google.cloud.notebooks_v1.services.notebook_service.NotebookServiceClient.get_instance_health
google.cloud.notebooks_v1.services.notebook_service.NotebookServiceClient.get_location
get_location(
request: typing.Optional[
google.cloud.location.locations_pb2.GetLocationRequest
] = 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.location.locations_pb2.Location
Gets information about a location.
See more: google.cloud.notebooks_v1.services.notebook_service.NotebookServiceClient.get_location
google.cloud.notebooks_v1.services.notebook_service.NotebookServiceClient.get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: typing.Optional[
google.api_core.client_options.ClientOptions
] = None,
)
Deprecated.
google.cloud.notebooks_v1.services.notebook_service.NotebookServiceClient.get_operation
get_operation(
request: typing.Optional[
google.longrunning.operations_pb2.GetOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Gets the latest state of a long-running operation.
See more: google.cloud.notebooks_v1.services.notebook_service.NotebookServiceClient.get_operation
google.cloud.notebooks_v1.services.notebook_service.NotebookServiceClient.get_schedule
get_schedule(
request: typing.Optional[
typing.Union[google.cloud.notebooks_v1.types.service.GetScheduleRequest, 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.notebooks_v1.types.schedule.Schedule
Gets details of schedule.
See more: google.cloud.notebooks_v1.services.notebook_service.NotebookServiceClient.get_schedule
google.cloud.notebooks_v1.services.notebook_service.NotebookServiceClient.instance_path
instance_path(project: str, instance: str) -> str
Returns a fully-qualified instance string.
See more: google.cloud.notebooks_v1.services.notebook_service.NotebookServiceClient.instance_path
google.cloud.notebooks_v1.services.notebook_service.NotebookServiceClient.is_instance_upgradeable
is_instance_upgradeable(
request: typing.Optional[
typing.Union[
google.cloud.notebooks_v1.types.service.IsInstanceUpgradeableRequest, 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.cloud.notebooks_v1.types.service.IsInstanceUpgradeableResponse
Check if a notebook instance is upgradable.
See more: google.cloud.notebooks_v1.services.notebook_service.NotebookServiceClient.is_instance_upgradeable
google.cloud.notebooks_v1.services.notebook_service.NotebookServiceClient.list_environments
list_environments(
request: typing.Optional[
typing.Union[
google.cloud.notebooks_v1.types.service.ListEnvironmentsRequest, dict
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.notebooks_v1.services.notebook_service.pagers.ListEnvironmentsPager
Lists environments in a project.
See more: google.cloud.notebooks_v1.services.notebook_service.NotebookServiceClient.list_environments
google.cloud.notebooks_v1.services.notebook_service.NotebookServiceClient.list_executions
list_executions(
request: typing.Optional[
typing.Union[
google.cloud.notebooks_v1.types.service.ListExecutionsRequest, dict
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.notebooks_v1.services.notebook_service.pagers.ListExecutionsPager
Lists executions in a given project and location.
See more: google.cloud.notebooks_v1.services.notebook_service.NotebookServiceClient.list_executions
google.cloud.notebooks_v1.services.notebook_service.NotebookServiceClient.list_instances
list_instances(
request: typing.Optional[
typing.Union[google.cloud.notebooks_v1.types.service.ListInstancesRequest, dict]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.notebooks_v1.services.notebook_service.pagers.ListInstancesPager
Lists instances in a given project and location.
See more: google.cloud.notebooks_v1.services.notebook_service.NotebookServiceClient.list_instances
google.cloud.notebooks_v1.services.notebook_service.NotebookServiceClient.list_locations
list_locations(
request: typing.Optional[
google.cloud.location.locations_pb2.ListLocationsRequest
] = 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.location.locations_pb2.ListLocationsResponse
Lists information about the supported locations for this service.
See more: google.cloud.notebooks_v1.services.notebook_service.NotebookServiceClient.list_locations
google.cloud.notebooks_v1.services.notebook_service.NotebookServiceClient.list_operations
list_operations(
request: typing.Optional[
google.longrunning.operations_pb2.ListOperationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse
Lists operations that match the specified filter in the request.
See more: google.cloud.notebooks_v1.services.notebook_service.NotebookServiceClient.list_operations
google.cloud.notebooks_v1.services.notebook_service.NotebookServiceClient.list_schedules
list_schedules(
request: typing.Optional[
typing.Union[google.cloud.notebooks_v1.types.service.ListSchedulesRequest, dict]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.notebooks_v1.services.notebook_service.pagers.ListSchedulesPager
Lists schedules in a given project and location.
See more: google.cloud.notebooks_v1.services.notebook_service.NotebookServiceClient.list_schedules
google.cloud.notebooks_v1.services.notebook_service.NotebookServiceClient.parse_common_billing_account_path
parse_common_billing_account_path(path: str) -> typing.Dict[str, str]
Parse a billing_account path into its component segments.
google.cloud.notebooks_v1.services.notebook_service.NotebookServiceClient.parse_common_folder_path
parse_common_folder_path(path: str) -> typing.Dict[str, str]
Parse a folder path into its component segments.
See more: google.cloud.notebooks_v1.services.notebook_service.NotebookServiceClient.parse_common_folder_path
google.cloud.notebooks_v1.services.notebook_service.NotebookServiceClient.parse_common_location_path
parse_common_location_path(path: str) -> typing.Dict[str, str]
Parse a location path into its component segments.
See more: google.cloud.notebooks_v1.services.notebook_service.NotebookServiceClient.parse_common_location_path
google.cloud.notebooks_v1.services.notebook_service.NotebookServiceClient.parse_common_organization_path
parse_common_organization_path(path: str) -> typing.Dict[str, str]
Parse a organization path into its component segments.
google.cloud.notebooks_v1.services.notebook_service.NotebookServiceClient.parse_common_project_path
parse_common_project_path(path: str) -> typing.Dict[str, str]
Parse a project path into its component segments.
See more: google.cloud.notebooks_v1.services.notebook_service.NotebookServiceClient.parse_common_project_path
google.cloud.notebooks_v1.services.notebook_service.NotebookServiceClient.parse_environment_path
parse_environment_path(path: str) -> typing.Dict[str, str]
Parses a environment path into its component segments.
See more: google.cloud.notebooks_v1.services.notebook_service.NotebookServiceClient.parse_environment_path
google.cloud.notebooks_v1.services.notebook_service.NotebookServiceClient.parse_execution_path
parse_execution_path(path: str) -> typing.Dict[str, str]
Parses a execution path into its component segments.
See more: google.cloud.notebooks_v1.services.notebook_service.NotebookServiceClient.parse_execution_path
google.cloud.notebooks_v1.services.notebook_service.NotebookServiceClient.parse_instance_path
parse_instance_path(path: str) -> typing.Dict[str, str]
Parses a instance path into its component segments.
See more: google.cloud.notebooks_v1.services.notebook_service.NotebookServiceClient.parse_instance_path
google.cloud.notebooks_v1.services.notebook_service.NotebookServiceClient.parse_schedule_path
parse_schedule_path(path: str) -> typing.Dict[str, str]
Parses a schedule path into its component segments.
See more: google.cloud.notebooks_v1.services.notebook_service.NotebookServiceClient.parse_schedule_path
google.cloud.notebooks_v1.services.notebook_service.NotebookServiceClient.parse_tensorboard_path
parse_tensorboard_path(path: str) -> typing.Dict[str, str]
Parses a tensorboard path into its component segments.
See more: google.cloud.notebooks_v1.services.notebook_service.NotebookServiceClient.parse_tensorboard_path
google.cloud.notebooks_v1.services.notebook_service.NotebookServiceClient.register_instance
register_instance(
request: typing.Optional[
typing.Union[
google.cloud.notebooks_v1.types.service.RegisterInstanceRequest, 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
Registers an existing legacy notebook instance to the Notebooks API server.
See more: google.cloud.notebooks_v1.services.notebook_service.NotebookServiceClient.register_instance
google.cloud.notebooks_v1.services.notebook_service.NotebookServiceClient.report_instance_info
report_instance_info(
request: typing.Optional[
typing.Union[
google.cloud.notebooks_v1.types.service.ReportInstanceInfoRequest, 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
Allows notebook instances to report their latest instance information to the Notebooks API server.
See more: google.cloud.notebooks_v1.services.notebook_service.NotebookServiceClient.report_instance_info
google.cloud.notebooks_v1.services.notebook_service.NotebookServiceClient.reset_instance
reset_instance(
request: typing.Optional[
typing.Union[google.cloud.notebooks_v1.types.service.ResetInstanceRequest, 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
Resets a notebook instance.
See more: google.cloud.notebooks_v1.services.notebook_service.NotebookServiceClient.reset_instance
google.cloud.notebooks_v1.services.notebook_service.NotebookServiceClient.rollback_instance
rollback_instance(
request: typing.Optional[
typing.Union[
google.cloud.notebooks_v1.types.service.RollbackInstanceRequest, 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
Rollbacks a notebook instance to the previous version.
See more: google.cloud.notebooks_v1.services.notebook_service.NotebookServiceClient.rollback_instance
google.cloud.notebooks_v1.services.notebook_service.NotebookServiceClient.schedule_path
schedule_path(project: str, location: str, schedule: str) -> str
Returns a fully-qualified schedule string.
See more: google.cloud.notebooks_v1.services.notebook_service.NotebookServiceClient.schedule_path
google.cloud.notebooks_v1.services.notebook_service.NotebookServiceClient.set_iam_policy
set_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Sets the IAM access control policy on the specified function.
See more: google.cloud.notebooks_v1.services.notebook_service.NotebookServiceClient.set_iam_policy
google.cloud.notebooks_v1.services.notebook_service.NotebookServiceClient.set_instance_accelerator
set_instance_accelerator(
request: typing.Optional[
typing.Union[
google.cloud.notebooks_v1.types.service.SetInstanceAcceleratorRequest, 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
Updates the guest accelerators of a single Instance.
See more: google.cloud.notebooks_v1.services.notebook_service.NotebookServiceClient.set_instance_accelerator
google.cloud.notebooks_v1.services.notebook_service.NotebookServiceClient.set_instance_labels
set_instance_labels(
request: typing.Optional[
typing.Union[
google.cloud.notebooks_v1.types.service.SetInstanceLabelsRequest, 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
Replaces all the labels of an Instance.
See more: google.cloud.notebooks_v1.services.notebook_service.NotebookServiceClient.set_instance_labels
google.cloud.notebooks_v1.services.notebook_service.NotebookServiceClient.set_instance_machine_type
set_instance_machine_type(
request: typing.Optional[
typing.Union[
google.cloud.notebooks_v1.types.service.SetInstanceMachineTypeRequest, 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
Updates the machine type of a single Instance.
See more: google.cloud.notebooks_v1.services.notebook_service.NotebookServiceClient.set_instance_machine_type
google.cloud.notebooks_v1.services.notebook_service.NotebookServiceClient.start_instance
start_instance(
request: typing.Optional[
typing.Union[google.cloud.notebooks_v1.types.service.StartInstanceRequest, 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 a notebook instance.
See more: google.cloud.notebooks_v1.services.notebook_service.NotebookServiceClient.start_instance
google.cloud.notebooks_v1.services.notebook_service.NotebookServiceClient.stop_instance
stop_instance(
request: typing.Optional[
typing.Union[google.cloud.notebooks_v1.types.service.StopInstanceRequest, 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
Stops a notebook instance.
See more: google.cloud.notebooks_v1.services.notebook_service.NotebookServiceClient.stop_instance
google.cloud.notebooks_v1.services.notebook_service.NotebookServiceClient.tensorboard_path
tensorboard_path(project: str, location: str, tensorboard: str) -> str
Returns a fully-qualified tensorboard string.
See more: google.cloud.notebooks_v1.services.notebook_service.NotebookServiceClient.tensorboard_path
google.cloud.notebooks_v1.services.notebook_service.NotebookServiceClient.test_iam_permissions
test_iam_permissions(
request: typing.Optional[
google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.iam_policy_pb2.TestIamPermissionsResponse
Tests the specified IAM permissions against the IAM access control policy for a function.
See more: google.cloud.notebooks_v1.services.notebook_service.NotebookServiceClient.test_iam_permissions
google.cloud.notebooks_v1.services.notebook_service.NotebookServiceClient.trigger_schedule
trigger_schedule(
request: typing.Optional[
typing.Union[
google.cloud.notebooks_v1.types.service.TriggerScheduleRequest, 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
Triggers execution of an existing schedule.
See more: google.cloud.notebooks_v1.services.notebook_service.NotebookServiceClient.trigger_schedule
google.cloud.notebooks_v1.services.notebook_service.NotebookServiceClient.update_instance_config
update_instance_config(
request: typing.Optional[
typing.Union[
google.cloud.notebooks_v1.types.service.UpdateInstanceConfigRequest, 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
Update Notebook Instance configurations.
See more: google.cloud.notebooks_v1.services.notebook_service.NotebookServiceClient.update_instance_config
google.cloud.notebooks_v1.services.notebook_service.NotebookServiceClient.update_instance_metadata_items
update_instance_metadata_items(
request: typing.Optional[
typing.Union[
google.cloud.notebooks_v1.types.service.UpdateInstanceMetadataItemsRequest,
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.cloud.notebooks_v1.types.service.UpdateInstanceMetadataItemsResponse
Add/update metadata items for an instance.
google.cloud.notebooks_v1.services.notebook_service.NotebookServiceClient.update_shielded_instance_config
update_shielded_instance_config(
request: typing.Optional[
typing.Union[
google.cloud.notebooks_v1.types.service.UpdateShieldedInstanceConfigRequest,
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
Updates the Shielded instance configuration of a single Instance.
google.cloud.notebooks_v1.services.notebook_service.NotebookServiceClient.upgrade_instance
upgrade_instance(
request: typing.Optional[
typing.Union[
google.cloud.notebooks_v1.types.service.UpgradeInstanceRequest, 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
Upgrades a notebook instance to the latest version.
See more: google.cloud.notebooks_v1.services.notebook_service.NotebookServiceClient.upgrade_instance
google.cloud.notebooks_v1.services.notebook_service.NotebookServiceClient.upgrade_instance_internal
upgrade_instance_internal(
request: typing.Optional[
typing.Union[
google.cloud.notebooks_v1.types.service.UpgradeInstanceInternalRequest, 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
Allows notebook instances to call this endpoint to upgrade themselves.
See more: google.cloud.notebooks_v1.services.notebook_service.NotebookServiceClient.upgrade_instance_internal
google.cloud.notebooks_v1.services.notebook_service.pagers.ListEnvironmentsAsyncPager
ListEnvironmentsAsyncPager(
method: typing.Callable[
[...],
typing.Awaitable[
google.cloud.notebooks_v1.types.service.ListEnvironmentsResponse
],
],
request: google.cloud.notebooks_v1.types.service.ListEnvironmentsRequest,
response: google.cloud.notebooks_v1.types.service.ListEnvironmentsResponse,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiates the pager.
See more: google.cloud.notebooks_v1.services.notebook_service.pagers.ListEnvironmentsAsyncPager
google.cloud.notebooks_v1.services.notebook_service.pagers.ListEnvironmentsPager
ListEnvironmentsPager(
method: typing.Callable[
[...], google.cloud.notebooks_v1.types.service.ListEnvironmentsResponse
],
request: google.cloud.notebooks_v1.types.service.ListEnvironmentsRequest,
response: google.cloud.notebooks_v1.types.service.ListEnvironmentsResponse,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiate the pager.
See more: google.cloud.notebooks_v1.services.notebook_service.pagers.ListEnvironmentsPager
google.cloud.notebooks_v1.services.notebook_service.pagers.ListExecutionsAsyncPager
ListExecutionsAsyncPager(
method: typing.Callable[
[...],
typing.Awaitable[
google.cloud.notebooks_v1.types.service.ListExecutionsResponse
],
],
request: google.cloud.notebooks_v1.types.service.ListExecutionsRequest,
response: google.cloud.notebooks_v1.types.service.ListExecutionsResponse,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiates the pager.
See more: google.cloud.notebooks_v1.services.notebook_service.pagers.ListExecutionsAsyncPager
google.cloud.notebooks_v1.services.notebook_service.pagers.ListExecutionsPager
ListExecutionsPager(
method: typing.Callable[
[...], google.cloud.notebooks_v1.types.service.ListExecutionsResponse
],
request: google.cloud.notebooks_v1.types.service.ListExecutionsRequest,
response: google.cloud.notebooks_v1.types.service.ListExecutionsResponse,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiate the pager.
See more: google.cloud.notebooks_v1.services.notebook_service.pagers.ListExecutionsPager
google.cloud.notebooks_v1.services.notebook_service.pagers.ListInstancesAsyncPager
ListInstancesAsyncPager(
method: typing.Callable[
[...],
typing.Awaitable[google.cloud.notebooks_v1.types.service.ListInstancesResponse],
],
request: google.cloud.notebooks_v1.types.service.ListInstancesRequest,
response: google.cloud.notebooks_v1.types.service.ListInstancesResponse,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiates the pager.
See more: google.cloud.notebooks_v1.services.notebook_service.pagers.ListInstancesAsyncPager
google.cloud.notebooks_v1.services.notebook_service.pagers.ListInstancesPager
ListInstancesPager(
method: typing.Callable[
[...], google.cloud.notebooks_v1.types.service.ListInstancesResponse
],
request: google.cloud.notebooks_v1.types.service.ListInstancesRequest,
response: google.cloud.notebooks_v1.types.service.ListInstancesResponse,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiate the pager.
See more: google.cloud.notebooks_v1.services.notebook_service.pagers.ListInstancesPager
google.cloud.notebooks_v1.services.notebook_service.pagers.ListSchedulesAsyncPager
ListSchedulesAsyncPager(
method: typing.Callable[
[...],
typing.Awaitable[google.cloud.notebooks_v1.types.service.ListSchedulesResponse],
],
request: google.cloud.notebooks_v1.types.service.ListSchedulesRequest,
response: google.cloud.notebooks_v1.types.service.ListSchedulesResponse,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiates the pager.
See more: google.cloud.notebooks_v1.services.notebook_service.pagers.ListSchedulesAsyncPager
google.cloud.notebooks_v1.services.notebook_service.pagers.ListSchedulesPager
ListSchedulesPager(
method: typing.Callable[
[...], google.cloud.notebooks_v1.types.service.ListSchedulesResponse
],
request: google.cloud.notebooks_v1.types.service.ListSchedulesRequest,
response: google.cloud.notebooks_v1.types.service.ListSchedulesResponse,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiate the pager.
See more: google.cloud.notebooks_v1.services.notebook_service.pagers.ListSchedulesPager
google.cloud.notebooks_v1beta1.services.notebook_service.NotebookServiceAsyncClient
NotebookServiceAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.notebooks_v1beta1.services.notebook_service.transports.base.NotebookServiceTransport, typing.Callable[[...], google.cloud.notebooks_v1beta1.services.notebook_service.transports.base.NotebookServiceTransport]]] = '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 notebook service async client.
See more: google.cloud.notebooks_v1beta1.services.notebook_service.NotebookServiceAsyncClient
google.cloud.notebooks_v1beta1.services.notebook_service.NotebookServiceAsyncClient.cancel_operation
cancel_operation(
request: typing.Optional[
google.longrunning.operations_pb2.CancelOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Starts asynchronous cancellation on a long-running operation.
See more: google.cloud.notebooks_v1beta1.services.notebook_service.NotebookServiceAsyncClient.cancel_operation
google.cloud.notebooks_v1beta1.services.notebook_service.NotebookServiceAsyncClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
google.cloud.notebooks_v1beta1.services.notebook_service.NotebookServiceAsyncClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
google.cloud.notebooks_v1beta1.services.notebook_service.NotebookServiceAsyncClient.common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
google.cloud.notebooks_v1beta1.services.notebook_service.NotebookServiceAsyncClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
google.cloud.notebooks_v1beta1.services.notebook_service.NotebookServiceAsyncClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
google.cloud.notebooks_v1beta1.services.notebook_service.NotebookServiceAsyncClient.create_environment
create_environment(
request: typing.Optional[
typing.Union[
google.cloud.notebooks_v1beta1.types.service.CreateEnvironmentRequest, 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
Creates a new Environment.
google.cloud.notebooks_v1beta1.services.notebook_service.NotebookServiceAsyncClient.create_instance
create_instance(
request: typing.Optional[
typing.Union[
google.cloud.notebooks_v1beta1.types.service.CreateInstanceRequest, 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
Creates a new Instance in a given project and location.
See more: google.cloud.notebooks_v1beta1.services.notebook_service.NotebookServiceAsyncClient.create_instance
google.cloud.notebooks_v1beta1.services.notebook_service.NotebookServiceAsyncClient.delete_environment
delete_environment(
request: typing.Optional[
typing.Union[
google.cloud.notebooks_v1beta1.types.service.DeleteEnvironmentRequest, 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
Deletes a single Environment.
google.cloud.notebooks_v1beta1.services.notebook_service.NotebookServiceAsyncClient.delete_instance
delete_instance(
request: typing.Optional[
typing.Union[
google.cloud.notebooks_v1beta1.types.service.DeleteInstanceRequest, 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
Deletes a single Instance.
See more: google.cloud.notebooks_v1beta1.services.notebook_service.NotebookServiceAsyncClient.delete_instance
google.cloud.notebooks_v1beta1.services.notebook_service.NotebookServiceAsyncClient.delete_operation
delete_operation(
request: typing.Optional[
google.longrunning.operations_pb2.DeleteOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Deletes a long-running operation.
See more: google.cloud.notebooks_v1beta1.services.notebook_service.NotebookServiceAsyncClient.delete_operation
google.cloud.notebooks_v1beta1.services.notebook_service.NotebookServiceAsyncClient.environment_path
environment_path(project: str, environment: str) -> str
Returns a fully-qualified environment string.
See more: google.cloud.notebooks_v1beta1.services.notebook_service.NotebookServiceAsyncClient.environment_path
google.cloud.notebooks_v1beta1.services.notebook_service.NotebookServiceAsyncClient.from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.notebooks_v1beta1.services.notebook_service.NotebookServiceAsyncClient.from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)
Creates an instance of this client using the provided credentials info.
google.cloud.notebooks_v1beta1.services.notebook_service.NotebookServiceAsyncClient.from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.notebooks_v1beta1.services.notebook_service.NotebookServiceAsyncClient.get_environment
get_environment(
request: typing.Optional[
typing.Union[
google.cloud.notebooks_v1beta1.types.service.GetEnvironmentRequest, 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.cloud.notebooks_v1beta1.types.environment.Environment
Gets details of a single Environment.
See more: google.cloud.notebooks_v1beta1.services.notebook_service.NotebookServiceAsyncClient.get_environment
google.cloud.notebooks_v1beta1.services.notebook_service.NotebookServiceAsyncClient.get_iam_policy
get_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Gets the IAM access control policy for a function.
See more: google.cloud.notebooks_v1beta1.services.notebook_service.NotebookServiceAsyncClient.get_iam_policy
google.cloud.notebooks_v1beta1.services.notebook_service.NotebookServiceAsyncClient.get_instance
get_instance(
request: typing.Optional[
typing.Union[
google.cloud.notebooks_v1beta1.types.service.GetInstanceRequest, 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.cloud.notebooks_v1beta1.types.instance.Instance
Gets details of a single Instance.
See more: google.cloud.notebooks_v1beta1.services.notebook_service.NotebookServiceAsyncClient.get_instance
google.cloud.notebooks_v1beta1.services.notebook_service.NotebookServiceAsyncClient.get_location
get_location(
request: typing.Optional[
google.cloud.location.locations_pb2.GetLocationRequest
] = 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.location.locations_pb2.Location
Gets information about a location.
See more: google.cloud.notebooks_v1beta1.services.notebook_service.NotebookServiceAsyncClient.get_location
google.cloud.notebooks_v1beta1.services.notebook_service.NotebookServiceAsyncClient.get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: typing.Optional[
google.api_core.client_options.ClientOptions
] = None,
)
Return the API endpoint and client cert source for mutual TLS.
google.cloud.notebooks_v1beta1.services.notebook_service.NotebookServiceAsyncClient.get_operation
get_operation(
request: typing.Optional[
google.longrunning.operations_pb2.GetOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Gets the latest state of a long-running operation.
See more: google.cloud.notebooks_v1beta1.services.notebook_service.NotebookServiceAsyncClient.get_operation
google.cloud.notebooks_v1beta1.services.notebook_service.NotebookServiceAsyncClient.get_transport_class
get_transport_class() -> (
typing.Type[
google.cloud.notebooks_v1beta1.services.notebook_service.transports.base.NotebookServiceTransport
]
)
Returns an appropriate transport class.
google.cloud.notebooks_v1beta1.services.notebook_service.NotebookServiceAsyncClient.instance_path
instance_path(project: str, instance: str) -> str
Returns a fully-qualified instance string.
See more: google.cloud.notebooks_v1beta1.services.notebook_service.NotebookServiceAsyncClient.instance_path
google.cloud.notebooks_v1beta1.services.notebook_service.NotebookServiceAsyncClient.is_instance_upgradeable
is_instance_upgradeable(
request: typing.Optional[
typing.Union[
google.cloud.notebooks_v1beta1.types.service.IsInstanceUpgradeableRequest,
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.cloud.notebooks_v1beta1.types.service.IsInstanceUpgradeableResponse
Check if a notebook instance is upgradable.
google.cloud.notebooks_v1beta1.services.notebook_service.NotebookServiceAsyncClient.list_environments
list_environments(
request: typing.Optional[
typing.Union[
google.cloud.notebooks_v1beta1.types.service.ListEnvironmentsRequest, 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.cloud.notebooks_v1beta1.services.notebook_service.pagers.ListEnvironmentsAsyncPager
)
Lists environments in a project.
google.cloud.notebooks_v1beta1.services.notebook_service.NotebookServiceAsyncClient.list_instances
list_instances(
request: typing.Optional[
typing.Union[
google.cloud.notebooks_v1beta1.types.service.ListInstancesRequest, 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.cloud.notebooks_v1beta1.services.notebook_service.pagers.ListInstancesAsyncPager
)
Lists instances in a given project and location.
See more: google.cloud.notebooks_v1beta1.services.notebook_service.NotebookServiceAsyncClient.list_instances
google.cloud.notebooks_v1beta1.services.notebook_service.NotebookServiceAsyncClient.list_locations
list_locations(
request: typing.Optional[
google.cloud.location.locations_pb2.ListLocationsRequest
] = 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.location.locations_pb2.ListLocationsResponse
Lists information about the supported locations for this service.
See more: google.cloud.notebooks_v1beta1.services.notebook_service.NotebookServiceAsyncClient.list_locations
google.cloud.notebooks_v1beta1.services.notebook_service.NotebookServiceAsyncClient.list_operations
list_operations(
request: typing.Optional[
google.longrunning.operations_pb2.ListOperationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse
Lists operations that match the specified filter in the request.
See more: google.cloud.notebooks_v1beta1.services.notebook_service.NotebookServiceAsyncClient.list_operations
google.cloud.notebooks_v1beta1.services.notebook_service.NotebookServiceAsyncClient.parse_common_billing_account_path
parse_common_billing_account_path(path: str) -> typing.Dict[str, str]
Parse a billing_account path into its component segments.
google.cloud.notebooks_v1beta1.services.notebook_service.NotebookServiceAsyncClient.parse_common_folder_path
parse_common_folder_path(path: str) -> typing.Dict[str, str]
Parse a folder path into its component segments.
google.cloud.notebooks_v1beta1.services.notebook_service.NotebookServiceAsyncClient.parse_common_location_path
parse_common_location_path(path: str) -> typing.Dict[str, str]
Parse a location path into its component segments.
google.cloud.notebooks_v1beta1.services.notebook_service.NotebookServiceAsyncClient.parse_common_organization_path
parse_common_organization_path(path: str) -> typing.Dict[str, str]
Parse a organization path into its component segments.
google.cloud.notebooks_v1beta1.services.notebook_service.NotebookServiceAsyncClient.parse_common_project_path
parse_common_project_path(path: str) -> typing.Dict[str, str]
Parse a project path into its component segments.
google.cloud.notebooks_v1beta1.services.notebook_service.NotebookServiceAsyncClient.parse_environment_path
parse_environment_path(path: str) -> typing.Dict[str, str]
Parses a environment path into its component segments.
google.cloud.notebooks_v1beta1.services.notebook_service.NotebookServiceAsyncClient.parse_instance_path
parse_instance_path(path: str) -> typing.Dict[str, str]
Parses a instance path into its component segments.
google.cloud.notebooks_v1beta1.services.notebook_service.NotebookServiceAsyncClient.register_instance
register_instance(
request: typing.Optional[
typing.Union[
google.cloud.notebooks_v1beta1.types.service.RegisterInstanceRequest, 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
Registers an existing legacy notebook instance to the Notebooks API server.
google.cloud.notebooks_v1beta1.services.notebook_service.NotebookServiceAsyncClient.report_instance_info
report_instance_info(
request: typing.Optional[
typing.Union[
google.cloud.notebooks_v1beta1.types.service.ReportInstanceInfoRequest, 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
Allows notebook instances to report their latest instance information to the Notebooks API server.
google.cloud.notebooks_v1beta1.services.notebook_service.NotebookServiceAsyncClient.reset_instance
reset_instance(
request: typing.Optional[
typing.Union[
google.cloud.notebooks_v1beta1.types.service.ResetInstanceRequest, 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
Resets a notebook instance.
See more: google.cloud.notebooks_v1beta1.services.notebook_service.NotebookServiceAsyncClient.reset_instance
google.cloud.notebooks_v1beta1.services.notebook_service.NotebookServiceAsyncClient.set_iam_policy
set_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Sets the IAM access control policy on the specified function.
See more: google.cloud.notebooks_v1beta1.services.notebook_service.NotebookServiceAsyncClient.set_iam_policy
google.cloud.notebooks_v1beta1.services.notebook_service.NotebookServiceAsyncClient.set_instance_accelerator
set_instance_accelerator(
request: typing.Optional[
typing.Union[
google.cloud.notebooks_v1beta1.types.service.SetInstanceAcceleratorRequest,
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
Updates the guest accelerators of a single Instance.
google.cloud.notebooks_v1beta1.services.notebook_service.NotebookServiceAsyncClient.set_instance_labels
set_instance_labels(
request: typing.Optional[
typing.Union[
google.cloud.notebooks_v1beta1.types.service.SetInstanceLabelsRequest, 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
Updates the labels of an Instance.
google.cloud.notebooks_v1beta1.services.notebook_service.NotebookServiceAsyncClient.set_instance_machine_type
set_instance_machine_type(
request: typing.Optional[
typing.Union[
google.cloud.notebooks_v1beta1.types.service.SetInstanceMachineTypeRequest,
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
Updates the machine type of a single Instance.
google.cloud.notebooks_v1beta1.services.notebook_service.NotebookServiceAsyncClient.start_instance
start_instance(
request: typing.Optional[
typing.Union[
google.cloud.notebooks_v1beta1.types.service.StartInstanceRequest, 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 a notebook instance.
See more: google.cloud.notebooks_v1beta1.services.notebook_service.NotebookServiceAsyncClient.start_instance
google.cloud.notebooks_v1beta1.services.notebook_service.NotebookServiceAsyncClient.stop_instance
stop_instance(
request: typing.Optional[
typing.Union[
google.cloud.notebooks_v1beta1.types.service.StopInstanceRequest, 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
Stops a notebook instance.
See more: google.cloud.notebooks_v1beta1.services.notebook_service.NotebookServiceAsyncClient.stop_instance
google.cloud.notebooks_v1beta1.services.notebook_service.NotebookServiceAsyncClient.test_iam_permissions
test_iam_permissions(
request: typing.Optional[
google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.iam_policy_pb2.TestIamPermissionsResponse
Tests the specified IAM permissions against the IAM access control policy for a function.
google.cloud.notebooks_v1beta1.services.notebook_service.NotebookServiceAsyncClient.upgrade_instance
upgrade_instance(
request: typing.Optional[
typing.Union[
google.cloud.notebooks_v1beta1.types.service.UpgradeInstanceRequest, 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
Upgrades a notebook instance to the latest version.
See more: google.cloud.notebooks_v1beta1.services.notebook_service.NotebookServiceAsyncClient.upgrade_instance
google.cloud.notebooks_v1beta1.services.notebook_service.NotebookServiceAsyncClient.upgrade_instance_internal
upgrade_instance_internal(
request: typing.Optional[
typing.Union[
google.cloud.notebooks_v1beta1.types.service.UpgradeInstanceInternalRequest,
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
Allows notebook instances to call this endpoint to upgrade themselves.
google.cloud.notebooks_v1beta1.services.notebook_service.NotebookServiceClient
NotebookServiceClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.notebooks_v1beta1.services.notebook_service.transports.base.NotebookServiceTransport, typing.Callable[[...], google.cloud.notebooks_v1beta1.services.notebook_service.transports.base.NotebookServiceTransport]]] = 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 notebook service client.
See more: google.cloud.notebooks_v1beta1.services.notebook_service.NotebookServiceClient
google.cloud.notebooks_v1beta1.services.notebook_service.NotebookServiceClient.__exit__
__exit__(type, value, traceback)
Releases underlying transport's resources.
See more: google.cloud.notebooks_v1beta1.services.notebook_service.NotebookServiceClient.exit
google.cloud.notebooks_v1beta1.services.notebook_service.NotebookServiceClient.cancel_operation
cancel_operation(
request: typing.Optional[
google.longrunning.operations_pb2.CancelOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Starts asynchronous cancellation on a long-running operation.
See more: google.cloud.notebooks_v1beta1.services.notebook_service.NotebookServiceClient.cancel_operation
google.cloud.notebooks_v1beta1.services.notebook_service.NotebookServiceClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
google.cloud.notebooks_v1beta1.services.notebook_service.NotebookServiceClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
See more: google.cloud.notebooks_v1beta1.services.notebook_service.NotebookServiceClient.common_folder_path
google.cloud.notebooks_v1beta1.services.notebook_service.NotebookServiceClient.common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
See more: google.cloud.notebooks_v1beta1.services.notebook_service.NotebookServiceClient.common_location_path
google.cloud.notebooks_v1beta1.services.notebook_service.NotebookServiceClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
google.cloud.notebooks_v1beta1.services.notebook_service.NotebookServiceClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
See more: google.cloud.notebooks_v1beta1.services.notebook_service.NotebookServiceClient.common_project_path
google.cloud.notebooks_v1beta1.services.notebook_service.NotebookServiceClient.create_environment
create_environment(
request: typing.Optional[
typing.Union[
google.cloud.notebooks_v1beta1.types.service.CreateEnvironmentRequest, 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
Creates a new Environment.
See more: google.cloud.notebooks_v1beta1.services.notebook_service.NotebookServiceClient.create_environment
google.cloud.notebooks_v1beta1.services.notebook_service.NotebookServiceClient.create_instance
create_instance(
request: typing.Optional[
typing.Union[
google.cloud.notebooks_v1beta1.types.service.CreateInstanceRequest, 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
Creates a new Instance in a given project and location.
See more: google.cloud.notebooks_v1beta1.services.notebook_service.NotebookServiceClient.create_instance
google.cloud.notebooks_v1beta1.services.notebook_service.NotebookServiceClient.delete_environment
delete_environment(
request: typing.Optional[
typing.Union[
google.cloud.notebooks_v1beta1.types.service.DeleteEnvironmentRequest, 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
Deletes a single Environment.
See more: google.cloud.notebooks_v1beta1.services.notebook_service.NotebookServiceClient.delete_environment
google.cloud.notebooks_v1beta1.services.notebook_service.NotebookServiceClient.delete_instance
delete_instance(
request: typing.Optional[
typing.Union[
google.cloud.notebooks_v1beta1.types.service.DeleteInstanceRequest, 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
Deletes a single Instance.
See more: google.cloud.notebooks_v1beta1.services.notebook_service.NotebookServiceClient.delete_instance
google.cloud.notebooks_v1beta1.services.notebook_service.NotebookServiceClient.delete_operation
delete_operation(
request: typing.Optional[
google.longrunning.operations_pb2.DeleteOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Deletes a long-running operation.
See more: google.cloud.notebooks_v1beta1.services.notebook_service.NotebookServiceClient.delete_operation
google.cloud.notebooks_v1beta1.services.notebook_service.NotebookServiceClient.environment_path
environment_path(project: str, environment: str) -> str
Returns a fully-qualified environment string.
See more: google.cloud.notebooks_v1beta1.services.notebook_service.NotebookServiceClient.environment_path
google.cloud.notebooks_v1beta1.services.notebook_service.NotebookServiceClient.from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.notebooks_v1beta1.services.notebook_service.NotebookServiceClient.from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)
Creates an instance of this client using the provided credentials info.
google.cloud.notebooks_v1beta1.services.notebook_service.NotebookServiceClient.from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.notebooks_v1beta1.services.notebook_service.NotebookServiceClient.get_environment
get_environment(
request: typing.Optional[
typing.Union[
google.cloud.notebooks_v1beta1.types.service.GetEnvironmentRequest, 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.cloud.notebooks_v1beta1.types.environment.Environment
Gets details of a single Environment.
See more: google.cloud.notebooks_v1beta1.services.notebook_service.NotebookServiceClient.get_environment
google.cloud.notebooks_v1beta1.services.notebook_service.NotebookServiceClient.get_iam_policy
get_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Gets the IAM access control policy for a function.
See more: google.cloud.notebooks_v1beta1.services.notebook_service.NotebookServiceClient.get_iam_policy
google.cloud.notebooks_v1beta1.services.notebook_service.NotebookServiceClient.get_instance
get_instance(
request: typing.Optional[
typing.Union[
google.cloud.notebooks_v1beta1.types.service.GetInstanceRequest, 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.cloud.notebooks_v1beta1.types.instance.Instance
Gets details of a single Instance.
See more: google.cloud.notebooks_v1beta1.services.notebook_service.NotebookServiceClient.get_instance
google.cloud.notebooks_v1beta1.services.notebook_service.NotebookServiceClient.get_location
get_location(
request: typing.Optional[
google.cloud.location.locations_pb2.GetLocationRequest
] = 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.location.locations_pb2.Location
Gets information about a location.
See more: google.cloud.notebooks_v1beta1.services.notebook_service.NotebookServiceClient.get_location
google.cloud.notebooks_v1beta1.services.notebook_service.NotebookServiceClient.get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: typing.Optional[
google.api_core.client_options.ClientOptions
] = None,
)
Deprecated.
google.cloud.notebooks_v1beta1.services.notebook_service.NotebookServiceClient.get_operation
get_operation(
request: typing.Optional[
google.longrunning.operations_pb2.GetOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Gets the latest state of a long-running operation.
See more: google.cloud.notebooks_v1beta1.services.notebook_service.NotebookServiceClient.get_operation
google.cloud.notebooks_v1beta1.services.notebook_service.NotebookServiceClient.instance_path
instance_path(project: str, instance: str) -> str
Returns a fully-qualified instance string.
See more: google.cloud.notebooks_v1beta1.services.notebook_service.NotebookServiceClient.instance_path
google.cloud.notebooks_v1beta1.services.notebook_service.NotebookServiceClient.is_instance_upgradeable
is_instance_upgradeable(
request: typing.Optional[
typing.Union[
google.cloud.notebooks_v1beta1.types.service.IsInstanceUpgradeableRequest,
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.cloud.notebooks_v1beta1.types.service.IsInstanceUpgradeableResponse
Check if a notebook instance is upgradable.
google.cloud.notebooks_v1beta1.services.notebook_service.NotebookServiceClient.list_environments
list_environments(
request: typing.Optional[
typing.Union[
google.cloud.notebooks_v1beta1.types.service.ListEnvironmentsRequest, 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.cloud.notebooks_v1beta1.services.notebook_service.pagers.ListEnvironmentsPager
)
Lists environments in a project.
See more: google.cloud.notebooks_v1beta1.services.notebook_service.NotebookServiceClient.list_environments
google.cloud.notebooks_v1beta1.services.notebook_service.NotebookServiceClient.list_instances
list_instances(
request: typing.Optional[
typing.Union[
google.cloud.notebooks_v1beta1.types.service.ListInstancesRequest, 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.cloud.notebooks_v1beta1.services.notebook_service.pagers.ListInstancesPager
Lists instances in a given project and location.
See more: google.cloud.notebooks_v1beta1.services.notebook_service.NotebookServiceClient.list_instances
google.cloud.notebooks_v1beta1.services.notebook_service.NotebookServiceClient.list_locations
list_locations(
request: typing.Optional[
google.cloud.location.locations_pb2.ListLocationsRequest
] = 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.location.locations_pb2.ListLocationsResponse
Lists information about the supported locations for this service.
See more: google.cloud.notebooks_v1beta1.services.notebook_service.NotebookServiceClient.list_locations
google.cloud.notebooks_v1beta1.services.notebook_service.NotebookServiceClient.list_operations
list_operations(
request: typing.Optional[
google.longrunning.operations_pb2.ListOperationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse
Lists operations that match the specified filter in the request.
See more: google.cloud.notebooks_v1beta1.services.notebook_service.NotebookServiceClient.list_operations
google.cloud.notebooks_v1beta1.services.notebook_service.NotebookServiceClient.parse_common_billing_account_path
parse_common_billing_account_path(path: str) -> typing.Dict[str, str]
Parse a billing_account path into its component segments.
google.cloud.notebooks_v1beta1.services.notebook_service.NotebookServiceClient.parse_common_folder_path
parse_common_folder_path(path: str) -> typing.Dict[str, str]
Parse a folder path into its component segments.
google.cloud.notebooks_v1beta1.services.notebook_service.NotebookServiceClient.parse_common_location_path
parse_common_location_path(path: str) -> typing.Dict[str, str]
Parse a location path into its component segments.
google.cloud.notebooks_v1beta1.services.notebook_service.NotebookServiceClient.parse_common_organization_path
parse_common_organization_path(path: str) -> typing.Dict[str, str]
Parse a organization path into its component segments.
google.cloud.notebooks_v1beta1.services.notebook_service.NotebookServiceClient.parse_common_project_path
parse_common_project_path(path: str) -> typing.Dict[str, str]
Parse a project path into its component segments.
google.cloud.notebooks_v1beta1.services.notebook_service.NotebookServiceClient.parse_environment_path
parse_environment_path(path: str) -> typing.Dict[str, str]
Parses a environment path into its component segments.
google.cloud.notebooks_v1beta1.services.notebook_service.NotebookServiceClient.parse_instance_path
parse_instance_path(path: str) -> typing.Dict[str, str]
Parses a instance path into its component segments.
See more: google.cloud.notebooks_v1beta1.services.notebook_service.NotebookServiceClient.parse_instance_path
google.cloud.notebooks_v1beta1.services.notebook_service.NotebookServiceClient.register_instance
register_instance(
request: typing.Optional[
typing.Union[
google.cloud.notebooks_v1beta1.types.service.RegisterInstanceRequest, 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
Registers an existing legacy notebook instance to the Notebooks API server.
See more: google.cloud.notebooks_v1beta1.services.notebook_service.NotebookServiceClient.register_instance
google.cloud.notebooks_v1beta1.services.notebook_service.NotebookServiceClient.report_instance_info
report_instance_info(
request: typing.Optional[
typing.Union[
google.cloud.notebooks_v1beta1.types.service.ReportInstanceInfoRequest, 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
Allows notebook instances to report their latest instance information to the Notebooks API server.
See more: google.cloud.notebooks_v1beta1.services.notebook_service.NotebookServiceClient.report_instance_info
google.cloud.notebooks_v1beta1.services.notebook_service.NotebookServiceClient.reset_instance
reset_instance(
request: typing.Optional[
typing.Union[
google.cloud.notebooks_v1beta1.types.service.ResetInstanceRequest, 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
Resets a notebook instance.
See more: google.cloud.notebooks_v1beta1.services.notebook_service.NotebookServiceClient.reset_instance
google.cloud.notebooks_v1beta1.services.notebook_service.NotebookServiceClient.set_iam_policy
set_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Sets the IAM access control policy on the specified function.
See more: google.cloud.notebooks_v1beta1.services.notebook_service.NotebookServiceClient.set_iam_policy
google.cloud.notebooks_v1beta1.services.notebook_service.NotebookServiceClient.set_instance_accelerator
set_instance_accelerator(
request: typing.Optional[
typing.Union[
google.cloud.notebooks_v1beta1.types.service.SetInstanceAcceleratorRequest,
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
Updates the guest accelerators of a single Instance.
google.cloud.notebooks_v1beta1.services.notebook_service.NotebookServiceClient.set_instance_labels
set_instance_labels(
request: typing.Optional[
typing.Union[
google.cloud.notebooks_v1beta1.types.service.SetInstanceLabelsRequest, 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
Updates the labels of an Instance.
See more: google.cloud.notebooks_v1beta1.services.notebook_service.NotebookServiceClient.set_instance_labels
google.cloud.notebooks_v1beta1.services.notebook_service.NotebookServiceClient.set_instance_machine_type
set_instance_machine_type(
request: typing.Optional[
typing.Union[
google.cloud.notebooks_v1beta1.types.service.SetInstanceMachineTypeRequest,
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
Updates the machine type of a single Instance.
google.cloud.notebooks_v1beta1.services.notebook_service.NotebookServiceClient.start_instance
start_instance(
request: typing.Optional[
typing.Union[
google.cloud.notebooks_v1beta1.types.service.StartInstanceRequest, 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 a notebook instance.
See more: google.cloud.notebooks_v1beta1.services.notebook_service.NotebookServiceClient.start_instance
google.cloud.notebooks_v1beta1.services.notebook_service.NotebookServiceClient.stop_instance
stop_instance(
request: typing.Optional[
typing.Union[
google.cloud.notebooks_v1beta1.types.service.StopInstanceRequest, 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
Stops a notebook instance.
See more: google.cloud.notebooks_v1beta1.services.notebook_service.NotebookServiceClient.stop_instance
google.cloud.notebooks_v1beta1.services.notebook_service.NotebookServiceClient.test_iam_permissions
test_iam_permissions(
request: typing.Optional[
google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.iam_policy_pb2.TestIamPermissionsResponse
Tests the specified IAM permissions against the IAM access control policy for a function.
See more: google.cloud.notebooks_v1beta1.services.notebook_service.NotebookServiceClient.test_iam_permissions
google.cloud.notebooks_v1beta1.services.notebook_service.NotebookServiceClient.upgrade_instance
upgrade_instance(
request: typing.Optional[
typing.Union[
google.cloud.notebooks_v1beta1.types.service.UpgradeInstanceRequest, 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
Upgrades a notebook instance to the latest version.
See more: google.cloud.notebooks_v1beta1.services.notebook_service.NotebookServiceClient.upgrade_instance
google.cloud.notebooks_v1beta1.services.notebook_service.NotebookServiceClient.upgrade_instance_internal
upgrade_instance_internal(
request: typing.Optional[
typing.Union[
google.cloud.notebooks_v1beta1.types.service.UpgradeInstanceInternalRequest,
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
Allows notebook instances to call this endpoint to upgrade themselves.
google.cloud.notebooks_v1beta1.services.notebook_service.pagers.ListEnvironmentsAsyncPager
ListEnvironmentsAsyncPager(
method: typing.Callable[
[...],
typing.Awaitable[
google.cloud.notebooks_v1beta1.types.service.ListEnvironmentsResponse
],
],
request: google.cloud.notebooks_v1beta1.types.service.ListEnvironmentsRequest,
response: google.cloud.notebooks_v1beta1.types.service.ListEnvironmentsResponse,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiates the pager.
See more: google.cloud.notebooks_v1beta1.services.notebook_service.pagers.ListEnvironmentsAsyncPager
google.cloud.notebooks_v1beta1.services.notebook_service.pagers.ListEnvironmentsPager
ListEnvironmentsPager(
method: typing.Callable[
[...], google.cloud.notebooks_v1beta1.types.service.ListEnvironmentsResponse
],
request: google.cloud.notebooks_v1beta1.types.service.ListEnvironmentsRequest,
response: google.cloud.notebooks_v1beta1.types.service.ListEnvironmentsResponse,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiate the pager.
See more: google.cloud.notebooks_v1beta1.services.notebook_service.pagers.ListEnvironmentsPager
google.cloud.notebooks_v1beta1.services.notebook_service.pagers.ListInstancesAsyncPager
ListInstancesAsyncPager(
method: typing.Callable[
[...],
typing.Awaitable[
google.cloud.notebooks_v1beta1.types.service.ListInstancesResponse
],
],
request: google.cloud.notebooks_v1beta1.types.service.ListInstancesRequest,
response: google.cloud.notebooks_v1beta1.types.service.ListInstancesResponse,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiates the pager.
See more: google.cloud.notebooks_v1beta1.services.notebook_service.pagers.ListInstancesAsyncPager
google.cloud.notebooks_v1beta1.services.notebook_service.pagers.ListInstancesPager
ListInstancesPager(
method: typing.Callable[
[...], google.cloud.notebooks_v1beta1.types.service.ListInstancesResponse
],
request: google.cloud.notebooks_v1beta1.types.service.ListInstancesRequest,
response: google.cloud.notebooks_v1beta1.types.service.ListInstancesResponse,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiate the pager.
See more: google.cloud.notebooks_v1beta1.services.notebook_service.pagers.ListInstancesPager
google.cloud.notebooks_v2.services.notebook_service.NotebookServiceAsyncClient
NotebookServiceAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.notebooks_v2.services.notebook_service.transports.base.NotebookServiceTransport, typing.Callable[[...], google.cloud.notebooks_v2.services.notebook_service.transports.base.NotebookServiceTransport]]] = '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 notebook service async client.
See more: google.cloud.notebooks_v2.services.notebook_service.NotebookServiceAsyncClient
google.cloud.notebooks_v2.services.notebook_service.NotebookServiceAsyncClient.cancel_operation
cancel_operation(
request: typing.Optional[
google.longrunning.operations_pb2.CancelOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Starts asynchronous cancellation on a long-running operation.
See more: google.cloud.notebooks_v2.services.notebook_service.NotebookServiceAsyncClient.cancel_operation
google.cloud.notebooks_v2.services.notebook_service.NotebookServiceAsyncClient.check_instance_upgradability
check_instance_upgradability(
request: typing.Optional[
typing.Union[
google.cloud.notebooks_v2.types.service.CheckInstanceUpgradabilityRequest,
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.cloud.notebooks_v2.types.service.CheckInstanceUpgradabilityResponse
Checks whether a notebook instance is upgradable.
google.cloud.notebooks_v2.services.notebook_service.NotebookServiceAsyncClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
google.cloud.notebooks_v2.services.notebook_service.NotebookServiceAsyncClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
See more: google.cloud.notebooks_v2.services.notebook_service.NotebookServiceAsyncClient.common_folder_path
google.cloud.notebooks_v2.services.notebook_service.NotebookServiceAsyncClient.common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
See more: google.cloud.notebooks_v2.services.notebook_service.NotebookServiceAsyncClient.common_location_path
google.cloud.notebooks_v2.services.notebook_service.NotebookServiceAsyncClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
google.cloud.notebooks_v2.services.notebook_service.NotebookServiceAsyncClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
See more: google.cloud.notebooks_v2.services.notebook_service.NotebookServiceAsyncClient.common_project_path
google.cloud.notebooks_v2.services.notebook_service.NotebookServiceAsyncClient.create_instance
create_instance(
request: typing.Optional[
typing.Union[
google.cloud.notebooks_v2.types.service.CreateInstanceRequest, dict
]
] = None,
*,
parent: typing.Optional[str] = None,
instance: typing.Optional[google.cloud.notebooks_v2.types.instance.Instance] = None,
instance_id: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Creates a new Instance in a given project and location.
See more: google.cloud.notebooks_v2.services.notebook_service.NotebookServiceAsyncClient.create_instance
google.cloud.notebooks_v2.services.notebook_service.NotebookServiceAsyncClient.delete_instance
delete_instance(
request: typing.Optional[
typing.Union[
google.cloud.notebooks_v2.types.service.DeleteInstanceRequest, dict
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Deletes a single Instance.
See more: google.cloud.notebooks_v2.services.notebook_service.NotebookServiceAsyncClient.delete_instance
google.cloud.notebooks_v2.services.notebook_service.NotebookServiceAsyncClient.delete_operation
delete_operation(
request: typing.Optional[
google.longrunning.operations_pb2.DeleteOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Deletes a long-running operation.
See more: google.cloud.notebooks_v2.services.notebook_service.NotebookServiceAsyncClient.delete_operation
google.cloud.notebooks_v2.services.notebook_service.NotebookServiceAsyncClient.diagnose_instance
diagnose_instance(
request: typing.Optional[
typing.Union[
google.cloud.notebooks_v2.types.service.DiagnoseInstanceRequest, dict
]
] = None,
*,
name: typing.Optional[str] = None,
diagnostic_config: typing.Optional[
google.cloud.notebooks_v2.types.diagnostic_config.DiagnosticConfig
] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Creates a Diagnostic File and runs Diagnostic Tool given an Instance.
See more: google.cloud.notebooks_v2.services.notebook_service.NotebookServiceAsyncClient.diagnose_instance
google.cloud.notebooks_v2.services.notebook_service.NotebookServiceAsyncClient.from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.notebooks_v2.services.notebook_service.NotebookServiceAsyncClient.from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)
Creates an instance of this client using the provided credentials info.
google.cloud.notebooks_v2.services.notebook_service.NotebookServiceAsyncClient.from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.notebooks_v2.services.notebook_service.NotebookServiceAsyncClient.get_iam_policy
get_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Gets the IAM access control policy for a function.
See more: google.cloud.notebooks_v2.services.notebook_service.NotebookServiceAsyncClient.get_iam_policy
google.cloud.notebooks_v2.services.notebook_service.NotebookServiceAsyncClient.get_instance
get_instance(
request: typing.Optional[
typing.Union[google.cloud.notebooks_v2.types.service.GetInstanceRequest, 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.notebooks_v2.types.instance.Instance
Gets details of a single Instance.
See more: google.cloud.notebooks_v2.services.notebook_service.NotebookServiceAsyncClient.get_instance
google.cloud.notebooks_v2.services.notebook_service.NotebookServiceAsyncClient.get_location
get_location(
request: typing.Optional[
google.cloud.location.locations_pb2.GetLocationRequest
] = 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.location.locations_pb2.Location
Gets information about a location.
See more: google.cloud.notebooks_v2.services.notebook_service.NotebookServiceAsyncClient.get_location
google.cloud.notebooks_v2.services.notebook_service.NotebookServiceAsyncClient.get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: typing.Optional[
google.api_core.client_options.ClientOptions
] = None,
)
Return the API endpoint and client cert source for mutual TLS.
google.cloud.notebooks_v2.services.notebook_service.NotebookServiceAsyncClient.get_operation
get_operation(
request: typing.Optional[
google.longrunning.operations_pb2.GetOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Gets the latest state of a long-running operation.
See more: google.cloud.notebooks_v2.services.notebook_service.NotebookServiceAsyncClient.get_operation
google.cloud.notebooks_v2.services.notebook_service.NotebookServiceAsyncClient.get_transport_class
get_transport_class() -> (
typing.Type[
google.cloud.notebooks_v2.services.notebook_service.transports.base.NotebookServiceTransport
]
)
Returns an appropriate transport class.
See more: google.cloud.notebooks_v2.services.notebook_service.NotebookServiceAsyncClient.get_transport_class
google.cloud.notebooks_v2.services.notebook_service.NotebookServiceAsyncClient.instance_path
instance_path(project: str, location: str, instance: str) -> str
Returns a fully-qualified instance string.
See more: google.cloud.notebooks_v2.services.notebook_service.NotebookServiceAsyncClient.instance_path
google.cloud.notebooks_v2.services.notebook_service.NotebookServiceAsyncClient.list_instances
list_instances(
request: typing.Optional[
typing.Union[google.cloud.notebooks_v2.types.service.ListInstancesRequest, dict]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.notebooks_v2.services.notebook_service.pagers.ListInstancesAsyncPager
Lists instances in a given project and location.
See more: google.cloud.notebooks_v2.services.notebook_service.NotebookServiceAsyncClient.list_instances
google.cloud.notebooks_v2.services.notebook_service.NotebookServiceAsyncClient.list_locations
list_locations(
request: typing.Optional[
google.cloud.location.locations_pb2.ListLocationsRequest
] = 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.location.locations_pb2.ListLocationsResponse
Lists information about the supported locations for this service.
See more: google.cloud.notebooks_v2.services.notebook_service.NotebookServiceAsyncClient.list_locations
google.cloud.notebooks_v2.services.notebook_service.NotebookServiceAsyncClient.list_operations
list_operations(
request: typing.Optional[
google.longrunning.operations_pb2.ListOperationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse
Lists operations that match the specified filter in the request.
See more: google.cloud.notebooks_v2.services.notebook_service.NotebookServiceAsyncClient.list_operations
google.cloud.notebooks_v2.services.notebook_service.NotebookServiceAsyncClient.parse_common_billing_account_path
parse_common_billing_account_path(path: str) -> typing.Dict[str, str]
Parse a billing_account path into its component segments.
google.cloud.notebooks_v2.services.notebook_service.NotebookServiceAsyncClient.parse_common_folder_path
parse_common_folder_path(path: str) -> typing.Dict[str, str]
Parse a folder path into its component segments.
google.cloud.notebooks_v2.services.notebook_service.NotebookServiceAsyncClient.parse_common_location_path
parse_common_location_path(path: str) -> typing.Dict[str, str]
Parse a location path into its component segments.
google.cloud.notebooks_v2.services.notebook_service.NotebookServiceAsyncClient.parse_common_organization_path
parse_common_organization_path(path: str) -> typing.Dict[str, str]
Parse a organization path into its component segments.
google.cloud.notebooks_v2.services.notebook_service.NotebookServiceAsyncClient.parse_common_project_path
parse_common_project_path(path: str) -> typing.Dict[str, str]
Parse a project path into its component segments.
google.cloud.notebooks_v2.services.notebook_service.NotebookServiceAsyncClient.parse_instance_path
parse_instance_path(path: str) -> typing.Dict[str, str]
Parses a instance path into its component segments.
See more: google.cloud.notebooks_v2.services.notebook_service.NotebookServiceAsyncClient.parse_instance_path
google.cloud.notebooks_v2.services.notebook_service.NotebookServiceAsyncClient.reset_instance
reset_instance(
request: typing.Optional[
typing.Union[google.cloud.notebooks_v2.types.service.ResetInstanceRequest, 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
Resets a notebook instance.
See more: google.cloud.notebooks_v2.services.notebook_service.NotebookServiceAsyncClient.reset_instance
google.cloud.notebooks_v2.services.notebook_service.NotebookServiceAsyncClient.rollback_instance
rollback_instance(
request: typing.Optional[
typing.Union[
google.cloud.notebooks_v2.types.service.RollbackInstanceRequest, 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
Rollbacks a notebook instance to the previous version.
See more: google.cloud.notebooks_v2.services.notebook_service.NotebookServiceAsyncClient.rollback_instance
google.cloud.notebooks_v2.services.notebook_service.NotebookServiceAsyncClient.set_iam_policy
set_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Sets the IAM access control policy on the specified function.
See more: google.cloud.notebooks_v2.services.notebook_service.NotebookServiceAsyncClient.set_iam_policy
google.cloud.notebooks_v2.services.notebook_service.NotebookServiceAsyncClient.start_instance
start_instance(
request: typing.Optional[
typing.Union[google.cloud.notebooks_v2.types.service.StartInstanceRequest, 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 a notebook instance.
See more: google.cloud.notebooks_v2.services.notebook_service.NotebookServiceAsyncClient.start_instance
google.cloud.notebooks_v2.services.notebook_service.NotebookServiceAsyncClient.stop_instance
stop_instance(
request: typing.Optional[
typing.Union[google.cloud.notebooks_v2.types.service.StopInstanceRequest, 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
Stops a notebook instance.
See more: google.cloud.notebooks_v2.services.notebook_service.NotebookServiceAsyncClient.stop_instance
google.cloud.notebooks_v2.services.notebook_service.NotebookServiceAsyncClient.test_iam_permissions
test_iam_permissions(
request: typing.Optional[
google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.iam_policy_pb2.TestIamPermissionsResponse
Tests the specified IAM permissions against the IAM access control policy for a function.
See more: google.cloud.notebooks_v2.services.notebook_service.NotebookServiceAsyncClient.test_iam_permissions
google.cloud.notebooks_v2.services.notebook_service.NotebookServiceAsyncClient.update_instance
update_instance(
request: typing.Optional[
typing.Union[
google.cloud.notebooks_v2.types.service.UpdateInstanceRequest, dict
]
] = None,
*,
instance: typing.Optional[google.cloud.notebooks_v2.types.instance.Instance] = None,
update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
UpdateInstance updates an Instance.
See more: google.cloud.notebooks_v2.services.notebook_service.NotebookServiceAsyncClient.update_instance
google.cloud.notebooks_v2.services.notebook_service.NotebookServiceAsyncClient.upgrade_instance
upgrade_instance(
request: typing.Optional[
typing.Union[
google.cloud.notebooks_v2.types.service.UpgradeInstanceRequest, 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
Upgrades a notebook instance to the latest version.
See more: google.cloud.notebooks_v2.services.notebook_service.NotebookServiceAsyncClient.upgrade_instance
google.cloud.notebooks_v2.services.notebook_service.NotebookServiceClient
NotebookServiceClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.notebooks_v2.services.notebook_service.transports.base.NotebookServiceTransport, typing.Callable[[...], google.cloud.notebooks_v2.services.notebook_service.transports.base.NotebookServiceTransport]]] = 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 notebook service client.
See more: google.cloud.notebooks_v2.services.notebook_service.NotebookServiceClient
google.cloud.notebooks_v2.services.notebook_service.NotebookServiceClient.__exit__
__exit__(type, value, traceback)
Releases underlying transport's resources.
See more: google.cloud.notebooks_v2.services.notebook_service.NotebookServiceClient.exit
google.cloud.notebooks_v2.services.notebook_service.NotebookServiceClient.cancel_operation
cancel_operation(
request: typing.Optional[
google.longrunning.operations_pb2.CancelOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Starts asynchronous cancellation on a long-running operation.
See more: google.cloud.notebooks_v2.services.notebook_service.NotebookServiceClient.cancel_operation
google.cloud.notebooks_v2.services.notebook_service.NotebookServiceClient.check_instance_upgradability
check_instance_upgradability(
request: typing.Optional[
typing.Union[
google.cloud.notebooks_v2.types.service.CheckInstanceUpgradabilityRequest,
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.cloud.notebooks_v2.types.service.CheckInstanceUpgradabilityResponse
Checks whether a notebook instance is upgradable.
google.cloud.notebooks_v2.services.notebook_service.NotebookServiceClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
google.cloud.notebooks_v2.services.notebook_service.NotebookServiceClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
See more: google.cloud.notebooks_v2.services.notebook_service.NotebookServiceClient.common_folder_path
google.cloud.notebooks_v2.services.notebook_service.NotebookServiceClient.common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
See more: google.cloud.notebooks_v2.services.notebook_service.NotebookServiceClient.common_location_path
google.cloud.notebooks_v2.services.notebook_service.NotebookServiceClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
See more: google.cloud.notebooks_v2.services.notebook_service.NotebookServiceClient.common_organization_path
google.cloud.notebooks_v2.services.notebook_service.NotebookServiceClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
See more: google.cloud.notebooks_v2.services.notebook_service.NotebookServiceClient.common_project_path
google.cloud.notebooks_v2.services.notebook_service.NotebookServiceClient.create_instance
create_instance(
request: typing.Optional[
typing.Union[
google.cloud.notebooks_v2.types.service.CreateInstanceRequest, dict
]
] = None,
*,
parent: typing.Optional[str] = None,
instance: typing.Optional[google.cloud.notebooks_v2.types.instance.Instance] = None,
instance_id: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Creates a new Instance in a given project and location.
See more: google.cloud.notebooks_v2.services.notebook_service.NotebookServiceClient.create_instance
google.cloud.notebooks_v2.services.notebook_service.NotebookServiceClient.delete_instance
delete_instance(
request: typing.Optional[
typing.Union[
google.cloud.notebooks_v2.types.service.DeleteInstanceRequest, dict
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Deletes a single Instance.
See more: google.cloud.notebooks_v2.services.notebook_service.NotebookServiceClient.delete_instance
google.cloud.notebooks_v2.services.notebook_service.NotebookServiceClient.delete_operation
delete_operation(
request: typing.Optional[
google.longrunning.operations_pb2.DeleteOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Deletes a long-running operation.
See more: google.cloud.notebooks_v2.services.notebook_service.NotebookServiceClient.delete_operation
google.cloud.notebooks_v2.services.notebook_service.NotebookServiceClient.diagnose_instance
diagnose_instance(
request: typing.Optional[
typing.Union[
google.cloud.notebooks_v2.types.service.DiagnoseInstanceRequest, dict
]
] = None,
*,
name: typing.Optional[str] = None,
diagnostic_config: typing.Optional[
google.cloud.notebooks_v2.types.diagnostic_config.DiagnosticConfig
] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Creates a Diagnostic File and runs Diagnostic Tool given an Instance.
See more: google.cloud.notebooks_v2.services.notebook_service.NotebookServiceClient.diagnose_instance
google.cloud.notebooks_v2.services.notebook_service.NotebookServiceClient.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.notebooks_v2.services.notebook_service.NotebookServiceClient.from_service_account_file
google.cloud.notebooks_v2.services.notebook_service.NotebookServiceClient.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.notebooks_v2.services.notebook_service.NotebookServiceClient.from_service_account_info
google.cloud.notebooks_v2.services.notebook_service.NotebookServiceClient.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.notebooks_v2.services.notebook_service.NotebookServiceClient.from_service_account_json
google.cloud.notebooks_v2.services.notebook_service.NotebookServiceClient.get_iam_policy
get_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Gets the IAM access control policy for a function.
See more: google.cloud.notebooks_v2.services.notebook_service.NotebookServiceClient.get_iam_policy
google.cloud.notebooks_v2.services.notebook_service.NotebookServiceClient.get_instance
get_instance(
request: typing.Optional[
typing.Union[google.cloud.notebooks_v2.types.service.GetInstanceRequest, 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.notebooks_v2.types.instance.Instance
Gets details of a single Instance.
See more: google.cloud.notebooks_v2.services.notebook_service.NotebookServiceClient.get_instance
google.cloud.notebooks_v2.services.notebook_service.NotebookServiceClient.get_location
get_location(
request: typing.Optional[
google.cloud.location.locations_pb2.GetLocationRequest
] = 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.location.locations_pb2.Location
Gets information about a location.
See more: google.cloud.notebooks_v2.services.notebook_service.NotebookServiceClient.get_location
google.cloud.notebooks_v2.services.notebook_service.NotebookServiceClient.get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: typing.Optional[
google.api_core.client_options.ClientOptions
] = None,
)
Deprecated.
google.cloud.notebooks_v2.services.notebook_service.NotebookServiceClient.get_operation
get_operation(
request: typing.Optional[
google.longrunning.operations_pb2.GetOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Gets the latest state of a long-running operation.
See more: google.cloud.notebooks_v2.services.notebook_service.NotebookServiceClient.get_operation
google.cloud.notebooks_v2.services.notebook_service.NotebookServiceClient.instance_path
instance_path(project: str, location: str, instance: str) -> str
Returns a fully-qualified instance string.
See more: google.cloud.notebooks_v2.services.notebook_service.NotebookServiceClient.instance_path
google.cloud.notebooks_v2.services.notebook_service.NotebookServiceClient.list_instances
list_instances(
request: typing.Optional[
typing.Union[google.cloud.notebooks_v2.types.service.ListInstancesRequest, dict]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.notebooks_v2.services.notebook_service.pagers.ListInstancesPager
Lists instances in a given project and location.
See more: google.cloud.notebooks_v2.services.notebook_service.NotebookServiceClient.list_instances
google.cloud.notebooks_v2.services.notebook_service.NotebookServiceClient.list_locations
list_locations(
request: typing.Optional[
google.cloud.location.locations_pb2.ListLocationsRequest
] = 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.location.locations_pb2.ListLocationsResponse
Lists information about the supported locations for this service.
See more: google.cloud.notebooks_v2.services.notebook_service.NotebookServiceClient.list_locations
google.cloud.notebooks_v2.services.notebook_service.NotebookServiceClient.list_operations
list_operations(
request: typing.Optional[
google.longrunning.operations_pb2.ListOperationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse
Lists operations that match the specified filter in the request.
See more: google.cloud.notebooks_v2.services.notebook_service.NotebookServiceClient.list_operations
google.cloud.notebooks_v2.services.notebook_service.NotebookServiceClient.parse_common_billing_account_path
parse_common_billing_account_path(path: str) -> typing.Dict[str, str]
Parse a billing_account path into its component segments.
google.cloud.notebooks_v2.services.notebook_service.NotebookServiceClient.parse_common_folder_path
parse_common_folder_path(path: str) -> typing.Dict[str, str]
Parse a folder path into its component segments.
See more: google.cloud.notebooks_v2.services.notebook_service.NotebookServiceClient.parse_common_folder_path
google.cloud.notebooks_v2.services.notebook_service.NotebookServiceClient.parse_common_location_path
parse_common_location_path(path: str) -> typing.Dict[str, str]
Parse a location path into its component segments.
See more: google.cloud.notebooks_v2.services.notebook_service.NotebookServiceClient.parse_common_location_path
google.cloud.notebooks_v2.services.notebook_service.NotebookServiceClient.parse_common_organization_path
parse_common_organization_path(path: str) -> typing.Dict[str, str]
Parse a organization path into its component segments.
google.cloud.notebooks_v2.services.notebook_service.NotebookServiceClient.parse_common_project_path
parse_common_project_path(path: str) -> typing.Dict[str, str]
Parse a project path into its component segments.
See more: google.cloud.notebooks_v2.services.notebook_service.NotebookServiceClient.parse_common_project_path
google.cloud.notebooks_v2.services.notebook_service.NotebookServiceClient.parse_instance_path
parse_instance_path(path: str) -> typing.Dict[str, str]
Parses a instance path into its component segments.
See more: google.cloud.notebooks_v2.services.notebook_service.NotebookServiceClient.parse_instance_path
google.cloud.notebooks_v2.services.notebook_service.NotebookServiceClient.reset_instance
reset_instance(
request: typing.Optional[
typing.Union[google.cloud.notebooks_v2.types.service.ResetInstanceRequest, 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
Resets a notebook instance.
See more: google.cloud.notebooks_v2.services.notebook_service.NotebookServiceClient.reset_instance
google.cloud.notebooks_v2.services.notebook_service.NotebookServiceClient.rollback_instance
rollback_instance(
request: typing.Optional[
typing.Union[
google.cloud.notebooks_v2.types.service.RollbackInstanceRequest, 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
Rollbacks a notebook instance to the previous version.
See more: google.cloud.notebooks_v2.services.notebook_service.NotebookServiceClient.rollback_instance
google.cloud.notebooks_v2.services.notebook_service.NotebookServiceClient.set_iam_policy
set_iam_policy(
request: typing.Optional[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Sets the IAM access control policy on the specified function.
See more: google.cloud.notebooks_v2.services.notebook_service.NotebookServiceClient.set_iam_policy
google.cloud.notebooks_v2.services.notebook_service.NotebookServiceClient.start_instance
start_instance(
request: typing.Optional[
typing.Union[google.cloud.notebooks_v2.types.service.StartInstanceRequest, 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 a notebook instance.
See more: google.cloud.notebooks_v2.services.notebook_service.NotebookServiceClient.start_instance
google.cloud.notebooks_v2.services.notebook_service.NotebookServiceClient.stop_instance
stop_instance(
request: typing.Optional[
typing.Union[google.cloud.notebooks_v2.types.service.StopInstanceRequest, 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
Stops a notebook instance.
See more: google.cloud.notebooks_v2.services.notebook_service.NotebookServiceClient.stop_instance
google.cloud.notebooks_v2.services.notebook_service.NotebookServiceClient.test_iam_permissions
test_iam_permissions(
request: typing.Optional[
google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.iam_policy_pb2.TestIamPermissionsResponse
Tests the specified IAM permissions against the IAM access control policy for a function.
See more: google.cloud.notebooks_v2.services.notebook_service.NotebookServiceClient.test_iam_permissions
google.cloud.notebooks_v2.services.notebook_service.NotebookServiceClient.update_instance
update_instance(
request: typing.Optional[
typing.Union[
google.cloud.notebooks_v2.types.service.UpdateInstanceRequest, dict
]
] = None,
*,
instance: typing.Optional[google.cloud.notebooks_v2.types.instance.Instance] = None,
update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
UpdateInstance updates an Instance.
See more: google.cloud.notebooks_v2.services.notebook_service.NotebookServiceClient.update_instance
google.cloud.notebooks_v2.services.notebook_service.NotebookServiceClient.upgrade_instance
upgrade_instance(
request: typing.Optional[
typing.Union[
google.cloud.notebooks_v2.types.service.UpgradeInstanceRequest, 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
Upgrades a notebook instance to the latest version.
See more: google.cloud.notebooks_v2.services.notebook_service.NotebookServiceClient.upgrade_instance
google.cloud.notebooks_v2.services.notebook_service.pagers.ListInstancesAsyncPager
ListInstancesAsyncPager(
method: typing.Callable[
[...],
typing.Awaitable[google.cloud.notebooks_v2.types.service.ListInstancesResponse],
],
request: google.cloud.notebooks_v2.types.service.ListInstancesRequest,
response: google.cloud.notebooks_v2.types.service.ListInstancesResponse,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiates the pager.
See more: google.cloud.notebooks_v2.services.notebook_service.pagers.ListInstancesAsyncPager
google.cloud.notebooks_v2.services.notebook_service.pagers.ListInstancesPager
ListInstancesPager(
method: typing.Callable[
[...], google.cloud.notebooks_v2.types.service.ListInstancesResponse
],
request: google.cloud.notebooks_v2.types.service.ListInstancesRequest,
response: google.cloud.notebooks_v2.types.service.ListInstancesResponse,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiate the pager.
See more: google.cloud.notebooks_v2.services.notebook_service.pagers.ListInstancesPager