Liking cljdoc? Tell your friends :D

happygapi.notebooks.projects

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

Notebooks API: projects.
AI Platform Notebooks API is used to manage notebook resources in Google Cloud.
See: https://cloud.google.com/ai-platform/notebooks/docs/api/reference/rest/v1/projects
raw docstring

locations-environments-create$clj

(locations-environments-create$ auth parameters body)

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

Required parameters: parent

Optional parameters: environmentId

Body:

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

Creates a new Environment.

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

Required parameters: parent

Optional parameters: environmentId

Body: 

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

Creates a new Environment.
raw docstring

locations-environments-delete$clj

(locations-environments-delete$ auth parameters)

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

Required parameters: name

Optional parameters: none

Deletes a single Environment.

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

Required parameters: name

Optional parameters: none

Deletes a single Environment.
raw docstring

locations-environments-get$clj

(locations-environments-get$ auth parameters)

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

Required parameters: name

Optional parameters: none

Gets details of a single Environment.

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

Required parameters: name

Optional parameters: none

Gets details of a single Environment.
raw docstring

locations-environments-list$clj

(locations-environments-list$ auth parameters)

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

Required parameters: parent

Optional parameters: pageToken, pageSize

Lists environments in a project.

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

Required parameters: parent

Optional parameters: pageToken, pageSize

Lists environments in a project.
raw docstring

locations-executions-create$clj

(locations-executions-create$ auth parameters body)

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

Required parameters: parent

Optional parameters: executionId

Body:

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

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

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

Required parameters: parent

Optional parameters: executionId

Body: 

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

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

locations-executions-delete$clj

(locations-executions-delete$ auth parameters)
https://cloud.google.com/ai-platform/notebooks/docs/api/reference/rest/v1/projects/locations/executions/delete

Required parameters: name

Optional parameters: none

Deletes execution
raw docstring

locations-executions-get$clj

(locations-executions-get$ auth parameters)

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

Required parameters: name

Optional parameters: none

Gets details of executions

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

Required parameters: name

Optional parameters: none

Gets details of executions
raw docstring

locations-executions-list$clj

(locations-executions-list$ auth parameters)

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

Required parameters: parent

Optional parameters: filter, pageToken, orderBy, pageSize

Lists executions in a given project and location

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

Required parameters: parent

Optional parameters: filter, pageToken, orderBy, pageSize

Lists executions in a given project and location
raw docstring

locations-get$clj

(locations-get$ auth parameters)

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

Required parameters: name

Optional parameters: none

Gets information about a location.

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

Required parameters: name

Optional parameters: none

Gets information about a location.
raw docstring

locations-instances-create$clj

(locations-instances-create$ auth parameters body)

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

Required parameters: parent

Optional parameters: instanceId

Body:

{:serviceAccount string, :tags [string], :labels {}, :shieldedInstanceConfig {:enableIntegrityMonitoring boolean, :enableSecureBoot boolean, :enableVtpm boolean}, :installGpuDriver boolean, :bootDiskSizeGb string, :diskEncryption string, :proxyUri string, :serviceAccountScopes [string], :containerImage {:repository string, :tag string}, :name string, :nicType string, :createTime string, :state string, :machineType string, :vmImage {:imageFamily string, :project string, :imageName 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, :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.

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

Required parameters: parent

Optional parameters: instanceId

Body: 

{:serviceAccount string,
 :tags [string],
 :labels {},
 :shieldedInstanceConfig {:enableIntegrityMonitoring boolean,
                          :enableSecureBoot boolean,
                          :enableVtpm boolean},
 :installGpuDriver boolean,
 :bootDiskSizeGb string,
 :diskEncryption string,
 :proxyUri string,
 :serviceAccountScopes [string],
 :containerImage {:repository string, :tag string},
 :name string,
 :nicType string,
 :createTime string,
 :state string,
 :machineType string,
 :vmImage {:imageFamily string, :project string, :imageName 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,
 :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.
raw docstring

locations-instances-delete$clj

(locations-instances-delete$ auth parameters)

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

Required parameters: name

Optional parameters: none

Deletes a single Instance.

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

Required parameters: name

Optional parameters: none

Deletes a single Instance.
raw docstring

locations-instances-get$clj

(locations-instances-get$ auth parameters)

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

Required parameters: name

Optional parameters: none

Gets details of a single Instance.

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

Required parameters: name

Optional parameters: none

Gets details of a single Instance.
raw docstring

locations-instances-getIamPolicy$clj

(locations-instances-getIamPolicy$ auth parameters)

https://cloud.google.com/ai-platform/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.

https://cloud.google.com/ai-platform/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.
raw docstring

locations-instances-getInstanceHealth$clj

(locations-instances-getInstanceHealth$ auth parameters)

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

Required parameters: name

Optional parameters: none

Check if a notebook instance is healthy.

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

Required parameters: name

Optional parameters: none

Check if a notebook instance is healthy.
raw docstring

locations-instances-isUpgradeable$clj

(locations-instances-isUpgradeable$ auth parameters)

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

Required parameters: notebookInstance

Optional parameters: none

Check if a notebook instance is upgradable.

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

Required parameters: notebookInstance

Optional parameters: none

Check if a notebook instance is upgradable.
raw docstring

locations-instances-list$clj

(locations-instances-list$ auth parameters)

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

Required parameters: parent

Optional parameters: pageToken, pageSize

Lists instances in a given project and location.

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

Required parameters: parent

Optional parameters: pageToken, pageSize

Lists instances in a given project and location.
raw docstring

locations-instances-register$clj

(locations-instances-register$ auth parameters body)

https://cloud.google.com/ai-platform/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.

https://cloud.google.com/ai-platform/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.
raw docstring

locations-instances-report$clj

(locations-instances-report$ auth parameters body)

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

Required parameters: name

Optional parameters: none

Body:

{:vmId string, :metadata {}}

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.

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

Required parameters: name

Optional parameters: none

Body: 

{:vmId string, :metadata {}}

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.
raw docstring

locations-instances-reset$clj

(locations-instances-reset$ auth parameters body)

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

Required parameters: name

Optional parameters: none

Body:

{}

Resets a notebook instance.

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

Required parameters: name

Optional parameters: none

Body: 

{}

Resets a notebook instance.
raw docstring

locations-instances-rollback$clj

(locations-instances-rollback$ auth parameters body)

https://cloud.google.com/ai-platform/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.

https://cloud.google.com/ai-platform/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.
raw docstring

locations-instances-setAccelerator$clj

(locations-instances-setAccelerator$ auth parameters body)

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

Required parameters: name

Optional parameters: none

Body:

{:coreCount string, :type string}

Updates the guest accelerators of a single Instance.

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

Required parameters: name

Optional parameters: none

Body: 

{:coreCount string, :type string}

Updates the guest accelerators of a single Instance.
raw docstring

locations-instances-setIamPolicy$clj

(locations-instances-setIamPolicy$ auth parameters body)

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

Required parameters: resource

Optional parameters: none

Body:

{:policy {:bindings [Binding], :version integer, :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.

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

Required parameters: resource

Optional parameters: none

Body: 

{:policy {:bindings [Binding], :version integer, :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.
raw docstring

locations-instances-setLabels$clj

(locations-instances-setLabels$ auth parameters body)

https://cloud.google.com/ai-platform/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.

https://cloud.google.com/ai-platform/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.
raw docstring

locations-instances-setMachineType$clj

(locations-instances-setMachineType$ auth parameters body)

https://cloud.google.com/ai-platform/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.

https://cloud.google.com/ai-platform/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.
raw docstring

locations-instances-start$clj

(locations-instances-start$ auth parameters body)

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

Required parameters: name

Optional parameters: none

Body:

{}

Starts a notebook instance.

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

Required parameters: name

Optional parameters: none

Body: 

{}

Starts a notebook instance.
raw docstring

locations-instances-stop$clj

(locations-instances-stop$ auth parameters body)

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

Required parameters: name

Optional parameters: none

Body:

{}

Stops a notebook instance.

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

Required parameters: name

Optional parameters: none

Body: 

{}

Stops a notebook instance.
raw docstring

locations-instances-testIamPermissions$clj

(locations-instances-testIamPermissions$ auth parameters body)

https://cloud.google.com/ai-platform/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.

https://cloud.google.com/ai-platform/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.
raw docstring

locations-instances-updateConfig$clj

(locations-instances-updateConfig$ auth parameters body)

https://cloud.google.com/ai-platform/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.

https://cloud.google.com/ai-platform/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.
raw docstring

locations-instances-updateShieldedInstanceConfig$clj

(locations-instances-updateShieldedInstanceConfig$ auth parameters body)

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

Required parameters: name

Optional parameters: none

Body:

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

Updates the Shielded instance configuration of a single Instance.

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

Required parameters: name

Optional parameters: none

Body: 

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

Updates the Shielded instance configuration of a single Instance.
raw docstring

locations-instances-upgrade$clj

(locations-instances-upgrade$ auth parameters body)

https://cloud.google.com/ai-platform/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.

https://cloud.google.com/ai-platform/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.
raw docstring

locations-instances-upgradeInternal$clj

(locations-instances-upgradeInternal$ auth parameters body)

https://cloud.google.com/ai-platform/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.

https://cloud.google.com/ai-platform/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.
raw docstring

locations-list$clj

(locations-list$ auth parameters)

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

Required parameters: name

Optional parameters: pageSize, pageToken, filter

Lists information about the supported locations for this service.

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

Required parameters: name

Optional parameters: pageSize, pageToken, filter

Lists information about the supported locations for this service.
raw docstring

locations-operations-cancel$clj

(locations-operations-cancel$ auth parameters body)

https://cloud.google.com/ai-platform/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.

https://cloud.google.com/ai-platform/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`.
raw docstring

locations-operations-delete$clj

(locations-operations-delete$ auth parameters)

https://cloud.google.com/ai-platform/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.

https://cloud.google.com/ai-platform/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`.
raw docstring

locations-operations-get$clj

(locations-operations-get$ auth parameters)

https://cloud.google.com/ai-platform/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.

https://cloud.google.com/ai-platform/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.
raw docstring

locations-operations-list$clj

(locations-operations-list$ auth parameters)

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

Required parameters: name

Optional parameters: filter, pageToken, pageSize

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.

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

Required parameters: name

Optional parameters: filter, pageToken, pageSize

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.
raw docstring

locations-runtimes-create$clj

(locations-runtimes-create$ auth parameters body)

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

Required parameters: parent

Optional parameters: runtimeId

Body:

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

Creates a new Runtime in a given project and location.

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

Required parameters: parent

Optional parameters: runtimeId

Body: 

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

Creates a new Runtime in a given project and location.
raw docstring

locations-runtimes-delete$clj

(locations-runtimes-delete$ auth parameters)

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

Required parameters: name

Optional parameters: none

Deletes a single Runtime.

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

Required parameters: name

Optional parameters: none

Deletes a single Runtime.
raw docstring

locations-runtimes-get$clj

(locations-runtimes-get$ auth parameters)

https://cloud.google.com/ai-platform/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.

https://cloud.google.com/ai-platform/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.
raw docstring

locations-runtimes-list$clj

(locations-runtimes-list$ auth parameters)

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

Required parameters: parent

Optional parameters: pageSize, pageToken

Lists Runtimes in a given project and location.

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

Required parameters: parent

Optional parameters: pageSize, pageToken

Lists Runtimes in a given project and location.
raw docstring

locations-runtimes-reset$clj

(locations-runtimes-reset$ auth parameters body)

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

Required parameters: name

Optional parameters: none

Body:

{}

Resets a Managed Notebook Runtime.

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

Required parameters: name

Optional parameters: none

Body: 

{}

Resets a Managed Notebook Runtime.
raw docstring

locations-runtimes-start$clj

(locations-runtimes-start$ auth parameters body)

https://cloud.google.com/ai-platform/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

https://cloud.google.com/ai-platform/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
raw docstring

locations-runtimes-stop$clj

(locations-runtimes-stop$ auth parameters body)

https://cloud.google.com/ai-platform/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

https://cloud.google.com/ai-platform/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
raw docstring

locations-runtimes-switch$clj

(locations-runtimes-switch$ auth parameters body)

https://cloud.google.com/ai-platform/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.

https://cloud.google.com/ai-platform/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.
raw docstring

locations-schedules-create$clj

(locations-schedules-create$ auth parameters body)

https://cloud.google.com/ai-platform/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 {}, :paramsYamlFile string, :containerImageUri string, :inputNotebookFile string, :acceleratorConfig SchedulerAcceleratorConfig, :scaleTier string, :parameters string, :outputNotebookFolder string, :masterType string}, :recentExecutions [{:state string, :updateTime string, :executionTemplate ExecutionTemplate, :name string, :createTime string, :displayName string, :outputNotebookFile string, :description string}]}

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

https://cloud.google.com/ai-platform/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 {},
                     :paramsYamlFile string,
                     :containerImageUri string,
                     :inputNotebookFile string,
                     :acceleratorConfig SchedulerAcceleratorConfig,
                     :scaleTier string,
                     :parameters string,
                     :outputNotebookFolder string,
                     :masterType string},
 :recentExecutions [{:state string,
                     :updateTime string,
                     :executionTemplate ExecutionTemplate,
                     :name string,
                     :createTime string,
                     :displayName string,
                     :outputNotebookFile string,
                     :description string}]}

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

locations-schedules-delete$clj

(locations-schedules-delete$ auth parameters)

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

Required parameters: name

Optional parameters: none

Deletes schedule and all underlying jobs

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

Required parameters: name

Optional parameters: none

Deletes schedule and all underlying jobs
raw docstring

locations-schedules-get$clj

(locations-schedules-get$ auth parameters)

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

Required parameters: name

Optional parameters: none

Gets details of schedule

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

Required parameters: name

Optional parameters: none

Gets details of schedule
raw docstring

locations-schedules-list$clj

(locations-schedules-list$ auth parameters)

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

Required parameters: parent

Optional parameters: filter, pageSize, pageToken, orderBy

Lists schedules in a given project and location.

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

Required parameters: parent

Optional parameters: filter, pageSize, pageToken, orderBy

Lists schedules in a given project and location.
raw docstring

locations-schedules-trigger$clj

(locations-schedules-trigger$ auth parameters body)

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

Required parameters: name

Optional parameters: none

Body:

{}

Triggers execution of an existing schedule.

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

Required parameters: name

Optional parameters: none

Body: 

{}

Triggers execution of an existing schedule.
raw docstring

cljdoc is a website building & hosting documentation for Clojure/Script libraries

× close