Namespace Google.Apis.AIPlatformNotebooks.v1.Data
Classes
AcceleratorConfig
Definition of a hardware accelerator. Note that not all combinations of type
and core_count
are valid. See
GPUs on Compute Engine to find a valid combination.
TPUs are not supported.
Binding
Associates members
, or principals, with a role
.
BootImage
Definition of the boot image used by the Runtime. Used to facilitate runtime upgradeability.
CancelOperationRequest
The request message for Operations.CancelOperation.
ContainerImage
Definition of a container image for starting a notebook instance with the environment installed in a container.
DataprocParameters
Parameters used in Dataproc JobType executions.
DiagnoseInstanceRequest
Request for creating a notebook instance diagnostic file.
DiagnoseRuntimeRequest
Request for creating a notebook instance diagnostic file.
DiagnosticConfig
Defines flags that are used to run the diagnostic tool
Disk
An instance-attached disk resource.
Empty
A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
EncryptionConfig
Represents a custom encryption key configuration that can be applied to a resource. This will encrypt all disks in Virtual Machine.
Environment
Definition of a software environment that is used to start a notebook instance.
Event
The definition of an Event for a managed / semi-managed notebook instance.
Execution
The definition of a single executed notebook.
ExecutionTemplate
The description a notebook execution workload.
Expr
Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information.
GetInstanceHealthResponse
Response for checking if a notebook instance is healthy.
GuestOsFeature
Guest OS features for boot disk.
Instance
The definition of a notebook instance.
InstanceConfig
Notebook instance configurations that can be updated.
InstanceMigrationEligibility
InstanceMigrationEligibility represents the feasibility information of a migration from UmN to WbI.
IsInstanceUpgradeableResponse
Response for checking if a notebook instance is upgradeable.
ListEnvironmentsResponse
Response for listing environments.
ListExecutionsResponse
Response for listing scheduled notebook executions
ListInstancesResponse
Response for listing notebook instances.
ListLocationsResponse
The response message for Locations.ListLocations.
ListOperationsResponse
The response message for Operations.ListOperations.
ListRuntimesResponse
Response for listing Managed Notebook Runtimes.
ListSchedulesResponse
Response for listing scheduled notebook job.
LocalDisk
A Local attached disk resource.
LocalDiskInitializeParams
Input only. Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new runtime. This property is mutually exclusive with the source property; you can only define one or the other, but not both.
Location
A resource that represents a Google Cloud location.
MigrateInstanceRequest
Request for migrating a User-Managed Notebook to Workbench Instances.
MigrateRuntimeRequest
Request for migrating a Runtime to a Workbench Instance.
Operation
This resource represents a long-running operation that is the result of a network API call.
OperationMetadata
Represents the metadata of the long-running operation.
Policy
An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A
Policy
is a collection of bindings
. A binding
binds one or more members
, or principals, to a single
role
. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A
role
is a named list of permissions; each role
can be an IAM predefined role or a user-created custom role.
For some types of Google Cloud resources, a binding
can also specify a condition
, which is a logical
expression that allows access to a resource only if the expression evaluates to true
. A condition can add
constraints based on attributes of the request, the resource, or both. To learn which resources support
conditions in their IAM policies, see the IAM
documentation. JSON example:
{
"bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com",
"group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] },
{ "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": {
"title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time
< timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 }
YAML example:
bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com -
serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin -
members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable
access description: Does not grant access after Sep 2020 expression: request.time <
timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3
For a description of IAM and its features, see the IAM documentation.
RefreshRuntimeTokenInternalRequest
Request for getting a new access token.
RefreshRuntimeTokenInternalResponse
Response with a new access token.
RegisterInstanceRequest
Request for registering a notebook instance.
ReportInstanceEventRequest
Request for reporting a Managed Notebook Event.
ReportInstanceInfoRequest
Request for notebook instances to report information to Notebooks API.
ReportRuntimeEventRequest
Request for reporting a Managed Notebook Event.
ReservationAffinity
Reservation Affinity for consuming Zonal reservation.
ResetInstanceRequest
Request for resetting a notebook instance
ResetRuntimeRequest
Request for resetting a Managed Notebook Runtime.
RollbackInstanceRequest
Request for rollbacking a notebook instance
Runtime
The definition of a Runtime for a managed notebook instance.
RuntimeAcceleratorConfig
Definition of the types of hardware accelerators that can be used. See Compute Engine
AcceleratorTypes. Examples: *
nvidia-tesla-k80
* nvidia-tesla-p100
* nvidia-tesla-v100
* nvidia-tesla-p4
* nvidia-tesla-t4
*
nvidia-tesla-a100
RuntimeAccessConfig
Specifies the login configuration for Runtime
RuntimeGuestOsFeature
Optional. A list of features to enable on the guest operating system. Applicable only for bootable images. Read Enabling guest operating system features to see a list of available options. Guest OS features for boot disk.
RuntimeMetrics
Contains runtime daemon metrics, such as OS and kernels and sessions stats.
RuntimeMigrationEligibility
RuntimeMigrationEligibility represents the feasibility information of a migration from GmN to WbI.
RuntimeShieldedInstanceConfig
A set of Shielded Instance options. See Images using supported Shielded VM features. Not all combinations are valid.
RuntimeSoftwareConfig
Specifies the selection and configuration of software inside the runtime. The properties to set on runtime.
Properties keys are specified in key:value
format, for example: * idle_shutdown: true
*
idle_shutdown_timeout: 180
* enable_health_monitoring: true
Schedule
The definition of a schedule.
SchedulerAcceleratorConfig
Definition of a hardware accelerator. Note that not all combinations of type
and core_count
are valid. See
GPUs on Compute Engine to find a valid combination. TPUs are not
supported.
SetIamPolicyRequest
Request message for SetIamPolicy
method.
SetInstanceAcceleratorRequest
Request for setting instance accelerator.
SetInstanceLabelsRequest
Request for setting instance labels.
SetInstanceMachineTypeRequest
Request for setting instance machine type.
ShieldedInstanceConfig
A set of Shielded Instance options. See Images using supported Shielded VM features. Not all combinations are valid.
StartInstanceRequest
Request for starting a notebook instance
StartRuntimeRequest
Request for starting a Managed Notebook Runtime.
Status
The Status
type defines a logical error model that is suitable for different programming environments,
including REST APIs and RPC APIs. It is used by gRPC. Each Status
message contains
three pieces of data: error code, error message, and error details. You can find out more about this error model
and how to work with it in the API Design Guide.
StopInstanceRequest
Request for stopping a notebook instance
StopRuntimeRequest
Request for stopping a Managed Notebook Runtime.
SwitchRuntimeRequest
Request for switching a Managed Notebook Runtime.
TestIamPermissionsRequest
Request message for TestIamPermissions
method.
TestIamPermissionsResponse
Response message for TestIamPermissions
method.
TriggerScheduleRequest
Request for created scheduled notebooks
UpdateInstanceConfigRequest
Request for updating instance configurations.
UpdateInstanceMetadataItemsRequest
Request for adding/changing metadata items for an instance.
UpdateInstanceMetadataItemsResponse
Response for adding/changing metadata items for an instance.
UpdateShieldedInstanceConfigRequest
Request for updating the Shielded Instance config for a notebook instance. You can only use this method on a stopped instance
UpgradeHistoryEntry
The entry of VM image upgrade history.
UpgradeInstanceInternalRequest
Request for upgrading a notebook instance from within the VM
UpgradeInstanceRequest
Request for upgrading a notebook instance
UpgradeRuntimeRequest
Request for upgrading a Managed Notebook Runtime to the latest version. option (google.api.message_visibility).restriction = "TRUSTED_TESTER,SPECIAL_TESTER";
VertexAIParameters
Parameters used in Vertex AI JobType executions.
VirtualMachine
Runtime using Virtual Machine for computing.
VirtualMachineConfig
The config settings for virtual machine.
VmImage
Definition of a custom Compute Engine virtual machine image for starting a notebook instance with the environment installed directly on the VM.