happygapi.notebooks.projects — happygapi 0.4.8

Notebooks API: projects. Notebooks API is used to manage notebook resources in Google Cloud. See: https://cloud.google.com/notebooks/docs/api/reference/rest/v1/projects

locations-environments-create$ clj

(locations-environments-create$ auth parameters body)

https://cloud.google.com/notebooks/docs/api/reference/rest/v1/projects/locations/environments/create

Required parameters: parent

Optional parameters: environmentId

Body:

{:displayName string, :vmImage {:project string, :imageName string, :imageFamily string}, :containerImage {:tag string, :repository string}, :description string, :name string, :postStartupScript string, :createTime string}

Creates a new Environment.

locations-environments-delete$ clj

(locations-environments-delete$ auth parameters)

https://cloud.google.com/notebooks/docs/api/reference/rest/v1/projects/locations/environments/delete

Required parameters: name

Optional parameters: none

Deletes a single Environment.

locations-environments-get$ clj

(locations-environments-get$ auth parameters)

https://cloud.google.com/notebooks/docs/api/reference/rest/v1/projects/locations/environments/get

Required parameters: name

Optional parameters: none

Gets details of a single Environment.

locations-environments-list$ clj

(locations-environments-list$ auth parameters)

https://cloud.google.com/notebooks/docs/api/reference/rest/v1/projects/locations/environments/list

Required parameters: parent

Optional parameters: pageSize, pageToken

Lists environments in a project.

locations-executions-create$ clj

(locations-executions-create$ auth parameters body)

https://cloud.google.com/notebooks/docs/api/reference/rest/v1/projects/locations/executions/create

Required parameters: parent

Optional parameters: executionId

Body:

{:description string, :jobUri string, :displayName string, :name string, :createTime string, :state string, :outputNotebookFile string, :updateTime string, :executionTemplate {:serviceAccount string, :labels {}, :dataprocParameters DataprocParameters, :paramsYamlFile string, :vertexAiParameters VertexAIParameters, :containerImageUri string, :inputNotebookFile string, :acceleratorConfig SchedulerAcceleratorConfig, :scaleTier string, :parameters string, :outputNotebookFolder string, :jobType string, :masterType string}}

Creates a new Execution in a given project and location.

locations-executions-delete$ clj

(locations-executions-delete$ auth parameters)

https://cloud.google.com/notebooks/docs/api/reference/rest/v1/projects/locations/executions/delete

Required parameters: name

Optional parameters: none

Deletes execution

locations-executions-get$ clj

(locations-executions-get$ auth parameters)

https://cloud.google.com/notebooks/docs/api/reference/rest/v1/projects/locations/executions/get

Required parameters: name

Optional parameters: none

Gets details of executions

locations-executions-list$ clj

(locations-executions-list$ auth parameters)

https://cloud.google.com/notebooks/docs/api/reference/rest/v1/projects/locations/executions/list

Required parameters: parent

Optional parameters: pageSize, pageToken, filter, orderBy

Lists executions in a given project and location

locations-get$ clj

(locations-get$ auth parameters)

https://cloud.google.com/notebooks/docs/api/reference/rest/v1/projects/locations/get

Required parameters: name

Optional parameters: none

Gets information about a location.

locations-instances-create$ clj

(locations-instances-create$ auth parameters body)

https://cloud.google.com/notebooks/docs/api/reference/rest/v1/projects/locations/instances/create

Required parameters: parent

Optional parameters: instanceId

Body:

{:serviceAccount string, :tags [string], :labels {}, :shieldedInstanceConfig {:enableSecureBoot boolean, :enableVtpm boolean, :enableIntegrityMonitoring boolean}, :installGpuDriver boolean, :bootDiskSizeGb string, :diskEncryption string, :proxyUri string, :serviceAccountScopes [string], :containerImage {:tag string, :repository string}, :name string, :nicType string, :createTime string, :state string, :machineType string, :vmImage {:project string, :imageName string, :imageFamily string}, :updateTime string, :customGpuDriverPath string, :acceleratorConfig {:coreCount string, :type string}, :noProxyAccess boolean, :disks [{:interface string, :guestOsFeatures [GuestOsFeature], :index string, :deviceName string, :boot boolean, :mode string, :licenses [string], :type string, :source string, :autoDelete boolean, :kind string, :diskSizeGb string}], :kmsKey string, :postStartupScript string, :bootDiskType string, :noRemoveDataDisk boolean, :reservationAffinity {:consumeReservationType string, :values [string], :key string}, :network string, :dataDiskSizeGb string, :noPublicIp boolean, :subnet string, :upgradeHistory [{:containerImage string, :createTime string, :targetVersion string, :state string, :vmImage string, :snapshot string, :action string, :targetImage string, :version string, :framework string}], :dataDiskType string, :metadata {}, :instanceOwners [string]}

Creates a new Instance in a given project and location.

locations-instances-delete$ clj

(locations-instances-delete$ auth parameters)

https://cloud.google.com/notebooks/docs/api/reference/rest/v1/projects/locations/instances/delete

Required parameters: name

Optional parameters: none

Deletes a single Instance.

locations-instances-get$ clj

(locations-instances-get$ auth parameters)

https://cloud.google.com/notebooks/docs/api/reference/rest/v1/projects/locations/instances/get

Required parameters: name

Optional parameters: none

Gets details of a single Instance.

locations-instances-getIamPolicy$ clj

(locations-instances-getIamPolicy$ auth parameters)

https://cloud.google.com/notebooks/docs/api/reference/rest/v1/projects/locations/instances/getIamPolicy

Required parameters: resource

Optional parameters: options.requestedPolicyVersion

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

locations-instances-getInstanceHealth$ clj

(locations-instances-getInstanceHealth$ auth parameters)

https://cloud.google.com/notebooks/docs/api/reference/rest/v1/projects/locations/instances/getInstanceHealth

Required parameters: name

Optional parameters: none

Check if a notebook instance is healthy.

locations-instances-isUpgradeable$ clj

(locations-instances-isUpgradeable$ auth parameters)

https://cloud.google.com/notebooks/docs/api/reference/rest/v1/projects/locations/instances/isUpgradeable

Required parameters: notebookInstance

Optional parameters: none

Check if a notebook instance is upgradable.

locations-instances-list$ clj

(locations-instances-list$ auth parameters)

https://cloud.google.com/notebooks/docs/api/reference/rest/v1/projects/locations/instances/list

Required parameters: parent

Optional parameters: pageSize, pageToken

Lists instances in a given project and location.

locations-instances-register$ clj

(locations-instances-register$ auth parameters body)

https://cloud.google.com/notebooks/docs/api/reference/rest/v1/projects/locations/instances/register

Required parameters: parent

Optional parameters: none

Body:

{:instanceId string}

Registers an existing legacy notebook instance to the Notebooks API server. Legacy instances are instances created with the legacy Compute Engine calls. They are not manageable by the Notebooks API out of the box. This call makes these instances manageable by the Notebooks API.

locations-instances-report$ clj

(locations-instances-report$ auth parameters body)

https://cloud.google.com/notebooks/docs/api/reference/rest/v1/projects/locations/instances/report

Required parameters: name

Optional parameters: none

Body:

{:metadata {}, :vmId string}

Allows notebook instances to report their latest instance information to the Notebooks API server. The server will merge the reported information to the instance metadata store. Do not use this method directly.

locations-instances-reset$ clj

(locations-instances-reset$ auth parameters body)

https://cloud.google.com/notebooks/docs/api/reference/rest/v1/projects/locations/instances/reset

Required parameters: name

Optional parameters: none

Body:

{}

Resets a notebook instance.

locations-instances-rollback$ clj

(locations-instances-rollback$ auth parameters body)

https://cloud.google.com/notebooks/docs/api/reference/rest/v1/projects/locations/instances/rollback

Required parameters: name

Optional parameters: none

Body:

{:targetSnapshot string}

Rollbacks a notebook instance to the previous version.

locations-instances-setAccelerator$ clj

(locations-instances-setAccelerator$ auth parameters body)

https://cloud.google.com/notebooks/docs/api/reference/rest/v1/projects/locations/instances/setAccelerator

Required parameters: name

Optional parameters: none

Body:

{:type string, :coreCount string}

Updates the guest accelerators of a single Instance.

locations-instances-setIamPolicy$ clj

(locations-instances-setIamPolicy$ auth parameters body)

https://cloud.google.com/notebooks/docs/api/reference/rest/v1/projects/locations/instances/setIamPolicy

Required parameters: resource

Optional parameters: none

Body:

{:policy {:version integer, :bindings [Binding], :etag string}}

Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.

locations-instances-setLabels$ clj

(locations-instances-setLabels$ auth parameters body)

https://cloud.google.com/notebooks/docs/api/reference/rest/v1/projects/locations/instances/setLabels

Required parameters: name

Optional parameters: none

Body:

{:labels {}}

Replaces all the labels of an Instance.

locations-instances-setMachineType$ clj

(locations-instances-setMachineType$ auth parameters body)

https://cloud.google.com/notebooks/docs/api/reference/rest/v1/projects/locations/instances/setMachineType

Required parameters: name

Optional parameters: none

Body:

{:machineType string}

Updates the machine type of a single Instance.

locations-instances-start$ clj

(locations-instances-start$ auth parameters body)

https://cloud.google.com/notebooks/docs/api/reference/rest/v1/projects/locations/instances/start

Required parameters: name

Optional parameters: none

Body:

{}

Starts a notebook instance.

locations-instances-stop$ clj

(locations-instances-stop$ auth parameters body)

https://cloud.google.com/notebooks/docs/api/reference/rest/v1/projects/locations/instances/stop

Required parameters: name

Optional parameters: none

Body:

{}

Stops a notebook instance.

locations-instances-testIamPermissions$ clj

(locations-instances-testIamPermissions$ auth parameters body)

https://cloud.google.com/notebooks/docs/api/reference/rest/v1/projects/locations/instances/testIamPermissions

Required parameters: resource

Optional parameters: none

Body:

{:permissions [string]}

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

locations-instances-updateConfig$ clj

(locations-instances-updateConfig$ auth parameters body)

https://cloud.google.com/notebooks/docs/api/reference/rest/v1/projects/locations/instances/updateConfig

Required parameters: name

Optional parameters: none

Body:

{:config {:enableHealthMonitoring boolean, :notebookUpgradeSchedule string}}

Update Notebook Instance configurations.

locations-instances-updateShieldedInstanceConfig$ clj

(locations-instances-updateShieldedInstanceConfig$ auth parameters body)

https://cloud.google.com/notebooks/docs/api/reference/rest/v1/projects/locations/instances/updateShieldedInstanceConfig

Required parameters: name

Optional parameters: none

Body:

{:shieldedInstanceConfig {:enableSecureBoot boolean, :enableVtpm boolean, :enableIntegrityMonitoring boolean}}

Updates the Shielded instance configuration of a single Instance.

locations-instances-upgrade$ clj

(locations-instances-upgrade$ auth parameters body)

https://cloud.google.com/notebooks/docs/api/reference/rest/v1/projects/locations/instances/upgrade

Required parameters: name

Optional parameters: none

Body:

{}

Upgrades a notebook instance to the latest version.

locations-instances-upgradeInternal$ clj

(locations-instances-upgradeInternal$ auth parameters body)

https://cloud.google.com/notebooks/docs/api/reference/rest/v1/projects/locations/instances/upgradeInternal

Required parameters: name

Optional parameters: none

Body:

{:vmId string}

Allows notebook instances to call this endpoint to upgrade themselves. Do not use this method directly.

locations-list$ clj

(locations-list$ auth parameters)

https://cloud.google.com/notebooks/docs/api/reference/rest/v1/projects/locations/list

Required parameters: name

Optional parameters: filter, pageToken, pageSize

Lists information about the supported locations for this service.

locations-operations-cancel$ clj

(locations-operations-cancel$ auth parameters body)

https://cloud.google.com/notebooks/docs/api/reference/rest/v1/projects/locations/operations/cancel

Required parameters: name

Optional parameters: none

Body:

{}

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.

locations-operations-delete$ clj

(locations-operations-delete$ auth parameters)

https://cloud.google.com/notebooks/docs/api/reference/rest/v1/projects/locations/operations/delete

Required parameters: name

Optional parameters: none

Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED.

locations-operations-get$ clj

(locations-operations-get$ auth parameters)

https://cloud.google.com/notebooks/docs/api/reference/rest/v1/projects/locations/operations/get

Required parameters: name

Optional parameters: none

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

locations-operations-list$ clj

(locations-operations-list$ auth parameters)

https://cloud.google.com/notebooks/docs/api/reference/rest/v1/projects/locations/operations/list

Required parameters: name

Optional parameters: pageSize, pageToken, filter

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED. NOTE: the name binding allows API services to override the binding to use different resource name schemes, such as users/*/operations. To override the binding, API services can add a binding such as "/v1/{name=users/*}/operations" to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.

locations-runtimes-create$ clj

(locations-runtimes-create$ auth parameters body)

https://cloud.google.com/notebooks/docs/api/reference/rest/v1/projects/locations/runtimes/create

Required parameters: parent

Optional parameters: runtimeId

Body:

{:name string, :softwareConfig {:idleShutdown boolean, :enableHealthMonitoring boolean, :notebookUpgradeSchedule string, :installGpuDriver boolean, :customGpuDriverPath string, :idleShutdownTimeout integer, :postStartupScript string}, :createTime string, :state string, :updateTime string, :virtualMachine {:virtualMachineConfig VirtualMachineConfig, :instanceName string, :instanceId string}, :healthState string, :accessConfig {:proxyUri string, :accessType string, :runtimeOwner string}, :metrics {:systemMetrics {}}}

Creates a new Runtime in a given project and location.

locations-runtimes-delete$ clj

(locations-runtimes-delete$ auth parameters)

https://cloud.google.com/notebooks/docs/api/reference/rest/v1/projects/locations/runtimes/delete

Required parameters: name

Optional parameters: none

Deletes a single Runtime.

locations-runtimes-get$ clj

(locations-runtimes-get$ auth parameters)

https://cloud.google.com/notebooks/docs/api/reference/rest/v1/projects/locations/runtimes/get

Required parameters: name

Optional parameters: none

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

locations-runtimes-list$ clj

(locations-runtimes-list$ auth parameters)

https://cloud.google.com/notebooks/docs/api/reference/rest/v1/projects/locations/runtimes/list

Required parameters: parent

Optional parameters: pageToken, pageSize

Lists Runtimes in a given project and location.

locations-runtimes-reportEvent$ clj

(locations-runtimes-reportEvent$ auth parameters body)

https://cloud.google.com/notebooks/docs/api/reference/rest/v1/projects/locations/runtimes/reportEvent

Required parameters: name

Optional parameters: none

Body:

{:event {:reportTime string, :type string}, :vmId string}

Report and process a runtime event.

locations-runtimes-reset$ clj

(locations-runtimes-reset$ auth parameters body)

https://cloud.google.com/notebooks/docs/api/reference/rest/v1/projects/locations/runtimes/reset

Required parameters: name

Optional parameters: none

Body:

{}

Resets a Managed Notebook Runtime.

locations-runtimes-start$ clj

(locations-runtimes-start$ auth parameters body)

https://cloud.google.com/notebooks/docs/api/reference/rest/v1/projects/locations/runtimes/start

Required parameters: name

Optional parameters: none

Body:

{}

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

locations-runtimes-stop$ clj

(locations-runtimes-stop$ auth parameters body)

https://cloud.google.com/notebooks/docs/api/reference/rest/v1/projects/locations/runtimes/stop

Required parameters: name

Optional parameters: none

Body:

{}

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

locations-runtimes-switch$ clj

(locations-runtimes-switch$ auth parameters body)

https://cloud.google.com/notebooks/docs/api/reference/rest/v1/projects/locations/runtimes/switch

Required parameters: name

Optional parameters: none

Body:

{:machineType string, :acceleratorConfig {:type string, :coreCount string}}

Switch a Managed Notebook Runtime.

locations-schedules-create$ clj

(locations-schedules-create$ auth parameters body)

https://cloud.google.com/notebooks/docs/api/reference/rest/v1/projects/locations/schedules/create

Required parameters: parent

Optional parameters: scheduleId

Body:

{:description string, :timeZone string, :cronSchedule string, :displayName string, :name string, :createTime string, :state string, :updateTime string, :executionTemplate {:serviceAccount string, :labels {}, :dataprocParameters DataprocParameters, :paramsYamlFile string, :vertexAiParameters VertexAIParameters, :containerImageUri string, :inputNotebookFile string, :acceleratorConfig SchedulerAcceleratorConfig, :scaleTier string, :parameters string, :outputNotebookFolder string, :jobType string, :masterType string}, :recentExecutions [{:description string, :jobUri string, :displayName string, :name string, :createTime string, :state string, :outputNotebookFile string, :updateTime string, :executionTemplate ExecutionTemplate}]}

Creates a new Scheduled Notebook in a given project and location.

locations-schedules-delete$ clj

(locations-schedules-delete$ auth parameters)

https://cloud.google.com/notebooks/docs/api/reference/rest/v1/projects/locations/schedules/delete

Required parameters: name

Optional parameters: none

Deletes schedule and all underlying jobs

locations-schedules-get$ clj

(locations-schedules-get$ auth parameters)

https://cloud.google.com/notebooks/docs/api/reference/rest/v1/projects/locations/schedules/get

Required parameters: name

Optional parameters: none

Gets details of schedule

locations-schedules-list$ clj

(locations-schedules-list$ auth parameters)

https://cloud.google.com/notebooks/docs/api/reference/rest/v1/projects/locations/schedules/list

Required parameters: parent

Optional parameters: filter, orderBy, pageSize, pageToken

Lists schedules in a given project and location.

locations-schedules-trigger$ clj

(locations-schedules-trigger$ auth parameters body)

https://cloud.google.com/notebooks/docs/api/reference/rest/v1/projects/locations/schedules/trigger

Required parameters: name

Optional parameters: none

Body:

{}

Triggers execution of an existing schedule.