View Source GoogleApi.Notebooks.V1.Api.Projects (google_api_notebooks v0.14.0)
API calls for all endpoints tagged Projects
.
Summary
Functions
Creates a new Environment.
Deletes a single Environment.
Gets details of a single Environment.
Lists environments in a project.
Creates a new Execution in a given project and location.
Deletes execution
Gets details of executions
Lists executions in a given project and location
Gets information about a location.
Creates a new Instance in a given project and location.
Deletes a single Instance.
Creates a Diagnostic File and runs Diagnostic Tool given an Instance.
Gets details of a single Instance.
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
Checks whether a notebook instance is healthy.
Checks whether a notebook instance is upgradable.
Lists instances in a given project and location.
Migrates an existing User-Managed Notebook to Workbench Instances.
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.
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.
Reports and processes an instance event.
Resets a notebook instance.
Rollbacks a notebook instance to the previous version.
Updates the guest accelerators of a single Instance.
Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND
, INVALID_ARGUMENT
, and PERMISSION_DENIED
errors.
Replaces all the labels of an Instance.
Updates the machine type of a single Instance.
Starts a notebook instance.
Stops a notebook instance.
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.
Update Notebook Instance configurations.
Add/update metadata items for an instance.
Updates the Shielded instance configuration of a single Instance.
Upgrades a notebook instance to the latest version.
Allows notebook instances to call this endpoint to upgrade themselves. Do not use this method directly.
Lists information about the supported locations for this service.
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
.
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
.
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.
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED
.
Creates a new Runtime in a given project and location.
Deletes a single Runtime.
Creates a Diagnostic File and runs Diagnostic Tool given a Runtime.
Gets details of a single Runtime. The location must be a regional endpoint rather than zonal.
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
Lists Runtimes in a given project and location.
Migrate an existing Runtime to a new Workbench Instance.
Update Notebook Runtime configuration.
Gets an access token for the consumer service account that the customer attached to the runtime. Only accessible from the tenant instance.
Reports and processes a runtime event.
Resets a Managed Notebook Runtime.
Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND
, INVALID_ARGUMENT
, and PERMISSION_DENIED
errors.
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
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
Switch a Managed Notebook Runtime.
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.
Upgrades a Managed Notebook Runtime to the latest version.
Creates a new Scheduled Notebook in a given project and location.
Deletes schedule and all underlying jobs
Gets details of schedule
Lists schedules in a given project and location.
Triggers execution of an existing schedule.
Functions
notebooks_projects_locations_environments_create(connection, parent, optional_params \\ [], opts \\ [])
View Source@spec notebooks_projects_locations_environments_create( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Notebooks.V1.Model.Operation.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Creates a new Environment.
Parameters
-
connection
(type:GoogleApi.Notebooks.V1.Connection.t
) - Connection to server -
parent
(type:String.t
) - Required. Format:projects/{project_id}/locations/{location}
-
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:environmentId
(type:String.t
) - Required. User-defined unique ID of this environment. Theenvironment_id
must be 1 to 63 characters long and contain only lowercase letters, numeric characters, and dashes. The first character must be a lowercase letter and the last character cannot be a dash. -
:body
(type:GoogleApi.Notebooks.V1.Model.Environment.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Notebooks.V1.Model.Operation{}}
on success -
{:error, info}
on failure
notebooks_projects_locations_environments_delete(connection, name, optional_params \\ [], opts \\ [])
View Source@spec notebooks_projects_locations_environments_delete( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Notebooks.V1.Model.Operation.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Deletes a single Environment.
Parameters
-
connection
(type:GoogleApi.Notebooks.V1.Connection.t
) - Connection to server -
name
(type:String.t
) - Required. Format:projects/{project_id}/locations/{location}/environments/{environment_id}
-
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Notebooks.V1.Model.Operation{}}
on success -
{:error, info}
on failure
notebooks_projects_locations_environments_get(connection, name, optional_params \\ [], opts \\ [])
View Source@spec notebooks_projects_locations_environments_get( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Notebooks.V1.Model.Environment.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Gets details of a single Environment.
Parameters
-
connection
(type:GoogleApi.Notebooks.V1.Connection.t
) - Connection to server -
name
(type:String.t
) - Required. Format:projects/{project_id}/locations/{location}/environments/{environment_id}
-
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Notebooks.V1.Model.Environment{}}
on success -
{:error, info}
on failure
notebooks_projects_locations_environments_list(connection, parent, optional_params \\ [], opts \\ [])
View Source@spec notebooks_projects_locations_environments_list( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Notebooks.V1.Model.ListEnvironmentsResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Lists environments in a project.
Parameters
-
connection
(type:GoogleApi.Notebooks.V1.Connection.t
) - Connection to server -
parent
(type:String.t
) - Required. Format:projects/{project_id}/locations/{location}
-
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:pageSize
(type:integer()
) - Maximum return size of the list call. -
:pageToken
(type:String.t
) - A previous returned page token that can be used to continue listing from the last result.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Notebooks.V1.Model.ListEnvironmentsResponse{}}
on success -
{:error, info}
on failure
notebooks_projects_locations_executions_create(connection, parent, optional_params \\ [], opts \\ [])
View Source@spec notebooks_projects_locations_executions_create( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Notebooks.V1.Model.Operation.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Creates a new Execution in a given project and location.
Parameters
-
connection
(type:GoogleApi.Notebooks.V1.Connection.t
) - Connection to server -
parent
(type:String.t
) - Required. Format:parent=projects/{project_id}/locations/{location}
-
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:executionId
(type:String.t
) - Required. User-defined unique ID of this execution. -
:body
(type:GoogleApi.Notebooks.V1.Model.Execution.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Notebooks.V1.Model.Operation{}}
on success -
{:error, info}
on failure
notebooks_projects_locations_executions_delete(connection, name, optional_params \\ [], opts \\ [])
View Source@spec notebooks_projects_locations_executions_delete( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Notebooks.V1.Model.Operation.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Deletes execution
Parameters
-
connection
(type:GoogleApi.Notebooks.V1.Connection.t
) - Connection to server -
name
(type:String.t
) - Required. Format:projects/{project_id}/locations/{location}/executions/{execution_id}
-
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Notebooks.V1.Model.Operation{}}
on success -
{:error, info}
on failure
notebooks_projects_locations_executions_get(connection, name, optional_params \\ [], opts \\ [])
View Source@spec notebooks_projects_locations_executions_get( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Notebooks.V1.Model.Execution.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Gets details of executions
Parameters
-
connection
(type:GoogleApi.Notebooks.V1.Connection.t
) - Connection to server -
name
(type:String.t
) - Required. Format:projects/{project_id}/locations/{location}/executions/{execution_id}
-
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Notebooks.V1.Model.Execution{}}
on success -
{:error, info}
on failure
notebooks_projects_locations_executions_list(connection, parent, optional_params \\ [], opts \\ [])
View Source@spec notebooks_projects_locations_executions_list( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Notebooks.V1.Model.ListExecutionsResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Lists executions in a given project and location
Parameters
-
connection
(type:GoogleApi.Notebooks.V1.Connection.t
) - Connection to server -
parent
(type:String.t
) - Required. Format:parent=projects/{project_id}/locations/{location}
-
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:filter
(type:String.t
) - Filter applied to resulting executions. Currently only supports filtering executions by a specifiedschedule_id
. Format:schedule_id=
-
:orderBy
(type:String.t
) - Sort by field. -
:pageSize
(type:integer()
) - Maximum return size of the list call. -
:pageToken
(type:String.t
) - A previous returned page token that can be used to continue listing from the last result.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Notebooks.V1.Model.ListExecutionsResponse{}}
on success -
{:error, info}
on failure
notebooks_projects_locations_get(connection, name, optional_params \\ [], opts \\ [])
View Source@spec notebooks_projects_locations_get( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Notebooks.V1.Model.Location.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Gets information about a location.
Parameters
-
connection
(type:GoogleApi.Notebooks.V1.Connection.t
) - Connection to server -
name
(type:String.t
) - Resource name for the location. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Notebooks.V1.Model.Location{}}
on success -
{:error, info}
on failure
notebooks_projects_locations_instances_create(connection, parent, optional_params \\ [], opts \\ [])
View Source@spec notebooks_projects_locations_instances_create( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Notebooks.V1.Model.Operation.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Creates a new Instance in a given project and location.
Parameters
-
connection
(type:GoogleApi.Notebooks.V1.Connection.t
) - Connection to server -
parent
(type:String.t
) - Required. Format:parent=projects/{project_id}/locations/{location}
-
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:instanceId
(type:String.t
) - Required. User-defined unique ID of this instance. -
:body
(type:GoogleApi.Notebooks.V1.Model.Instance.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Notebooks.V1.Model.Operation{}}
on success -
{:error, info}
on failure
notebooks_projects_locations_instances_delete(connection, name, optional_params \\ [], opts \\ [])
View Source@spec notebooks_projects_locations_instances_delete( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Notebooks.V1.Model.Operation.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Deletes a single Instance.
Parameters
-
connection
(type:GoogleApi.Notebooks.V1.Connection.t
) - Connection to server -
name
(type:String.t
) - Required. Format:projects/{project_id}/locations/{location}/instances/{instance_id}
-
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Notebooks.V1.Model.Operation{}}
on success -
{:error, info}
on failure
notebooks_projects_locations_instances_diagnose(connection, name, optional_params \\ [], opts \\ [])
View Source@spec notebooks_projects_locations_instances_diagnose( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Notebooks.V1.Model.Operation.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Creates a Diagnostic File and runs Diagnostic Tool given an Instance.
Parameters
-
connection
(type:GoogleApi.Notebooks.V1.Connection.t
) - Connection to server -
name
(type:String.t
) - Required. Format:projects/{project_id}/locations/{location}/instances/{instance_id}
-
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:body
(type:GoogleApi.Notebooks.V1.Model.DiagnoseInstanceRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Notebooks.V1.Model.Operation{}}
on success -
{:error, info}
on failure
notebooks_projects_locations_instances_get(connection, name, optional_params \\ [], opts \\ [])
View Source@spec notebooks_projects_locations_instances_get( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Notebooks.V1.Model.Instance.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Gets details of a single Instance.
Parameters
-
connection
(type:GoogleApi.Notebooks.V1.Connection.t
) - Connection to server -
name
(type:String.t
) - Required. Format:projects/{project_id}/locations/{location}/instances/{instance_id}
-
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Notebooks.V1.Model.Instance{}}
on success -
{:error, info}
on failure
notebooks_projects_locations_instances_get_iam_policy(connection, resource, optional_params \\ [], opts \\ [])
View Source@spec notebooks_projects_locations_instances_get_iam_policy( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Notebooks.V1.Model.Policy.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
Parameters
-
connection
(type:GoogleApi.Notebooks.V1.Connection.t
) - Connection to server -
resource
(type:String.t
) - REQUIRED: The resource for which the policy is being requested. See Resource names for the appropriate value for this field. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:"options.requestedPolicyVersion"
(type:integer()
) - Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the IAM documentation.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Notebooks.V1.Model.Policy{}}
on success -
{:error, info}
on failure
notebooks_projects_locations_instances_get_instance_health(connection, name, optional_params \\ [], opts \\ [])
View Source@spec notebooks_projects_locations_instances_get_instance_health( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Notebooks.V1.Model.GetInstanceHealthResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Checks whether a notebook instance is healthy.
Parameters
-
connection
(type:GoogleApi.Notebooks.V1.Connection.t
) - Connection to server -
name
(type:String.t
) - Required. Format:projects/{project_id}/locations/{location}/instances/{instance_id}
-
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Notebooks.V1.Model.GetInstanceHealthResponse{}}
on success -
{:error, info}
on failure
notebooks_projects_locations_instances_is_upgradeable(connection, notebook_instance, optional_params \\ [], opts \\ [])
View Source@spec notebooks_projects_locations_instances_is_upgradeable( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Notebooks.V1.Model.IsInstanceUpgradeableResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Checks whether a notebook instance is upgradable.
Parameters
-
connection
(type:GoogleApi.Notebooks.V1.Connection.t
) - Connection to server -
notebook_instance
(type:String.t
) - Required. Format:projects/{project_id}/locations/{location}/instances/{instance_id}
-
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:type
(type:String.t
) - Optional. The optional UpgradeType. Setting this field will search for additional compute images to upgrade this instance.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Notebooks.V1.Model.IsInstanceUpgradeableResponse{}}
on success -
{:error, info}
on failure
notebooks_projects_locations_instances_list(connection, parent, optional_params \\ [], opts \\ [])
View Source@spec notebooks_projects_locations_instances_list( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Notebooks.V1.Model.ListInstancesResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Lists instances in a given project and location.
Parameters
-
connection
(type:GoogleApi.Notebooks.V1.Connection.t
) - Connection to server -
parent
(type:String.t
) - Required. Format:parent=projects/{project_id}/locations/{location}
-
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:filter
(type:String.t
) - Optional. List filter. -
:orderBy
(type:String.t
) - Optional. Sort results. Supported values are "name", "name desc" or "" (unsorted). -
:pageSize
(type:integer()
) - Maximum return size of the list call. -
:pageToken
(type:String.t
) - A previous returned page token that can be used to continue listing from the last result.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Notebooks.V1.Model.ListInstancesResponse{}}
on success -
{:error, info}
on failure
notebooks_projects_locations_instances_migrate(connection, name, optional_params \\ [], opts \\ [])
View Source@spec notebooks_projects_locations_instances_migrate( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Notebooks.V1.Model.Operation.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Migrates an existing User-Managed Notebook to Workbench Instances.
Parameters
-
connection
(type:GoogleApi.Notebooks.V1.Connection.t
) - Connection to server -
name
(type:String.t
) - Required. Format:projects/{project_id}/locations/{location}/instances/{instance_id}
-
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:body
(type:GoogleApi.Notebooks.V1.Model.MigrateInstanceRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Notebooks.V1.Model.Operation{}}
on success -
{:error, info}
on failure
notebooks_projects_locations_instances_register(connection, parent, optional_params \\ [], opts \\ [])
View Source@spec notebooks_projects_locations_instances_register( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Notebooks.V1.Model.Operation.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
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.
Parameters
-
connection
(type:GoogleApi.Notebooks.V1.Connection.t
) - Connection to server -
parent
(type:String.t
) - Required. Format:parent=projects/{project_id}/locations/{location}
-
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:body
(type:GoogleApi.Notebooks.V1.Model.RegisterInstanceRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Notebooks.V1.Model.Operation{}}
on success -
{:error, info}
on failure
notebooks_projects_locations_instances_report(connection, name, optional_params \\ [], opts \\ [])
View Source@spec notebooks_projects_locations_instances_report( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Notebooks.V1.Model.Operation.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
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.
Parameters
-
connection
(type:GoogleApi.Notebooks.V1.Connection.t
) - Connection to server -
name
(type:String.t
) - Required. Format:projects/{project_id}/locations/{location}/instances/{instance_id}
-
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:body
(type:GoogleApi.Notebooks.V1.Model.ReportInstanceInfoRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Notebooks.V1.Model.Operation{}}
on success -
{:error, info}
on failure
notebooks_projects_locations_instances_report_event(connection, name, optional_params \\ [], opts \\ [])
View Source@spec notebooks_projects_locations_instances_report_event( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Notebooks.V1.Model.Operation.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Reports and processes an instance event.
Parameters
-
connection
(type:GoogleApi.Notebooks.V1.Connection.t
) - Connection to server -
name
(type:String.t
) - Required. Format:projects/{project_id}/locations/{location}/instances/{instance_id}
-
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:body
(type:GoogleApi.Notebooks.V1.Model.ReportInstanceEventRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Notebooks.V1.Model.Operation{}}
on success -
{:error, info}
on failure
notebooks_projects_locations_instances_reset(connection, name, optional_params \\ [], opts \\ [])
View Source@spec notebooks_projects_locations_instances_reset( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Notebooks.V1.Model.Operation.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Resets a notebook instance.
Parameters
-
connection
(type:GoogleApi.Notebooks.V1.Connection.t
) - Connection to server -
name
(type:String.t
) - Required. Format:projects/{project_id}/locations/{location}/instances/{instance_id}
-
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:body
(type:GoogleApi.Notebooks.V1.Model.ResetInstanceRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Notebooks.V1.Model.Operation{}}
on success -
{:error, info}
on failure
notebooks_projects_locations_instances_rollback(connection, name, optional_params \\ [], opts \\ [])
View Source@spec notebooks_projects_locations_instances_rollback( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Notebooks.V1.Model.Operation.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Rollbacks a notebook instance to the previous version.
Parameters
-
connection
(type:GoogleApi.Notebooks.V1.Connection.t
) - Connection to server -
name
(type:String.t
) - Required. Format:projects/{project_id}/locations/{location}/instances/{instance_id}
-
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:body
(type:GoogleApi.Notebooks.V1.Model.RollbackInstanceRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Notebooks.V1.Model.Operation{}}
on success -
{:error, info}
on failure
notebooks_projects_locations_instances_set_accelerator(connection, name, optional_params \\ [], opts \\ [])
View Source@spec notebooks_projects_locations_instances_set_accelerator( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Notebooks.V1.Model.Operation.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Updates the guest accelerators of a single Instance.
Parameters
-
connection
(type:GoogleApi.Notebooks.V1.Connection.t
) - Connection to server -
name
(type:String.t
) - Required. Format:projects/{project_id}/locations/{location}/instances/{instance_id}
-
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:body
(type:GoogleApi.Notebooks.V1.Model.SetInstanceAcceleratorRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Notebooks.V1.Model.Operation{}}
on success -
{:error, info}
on failure
notebooks_projects_locations_instances_set_iam_policy(connection, resource, optional_params \\ [], opts \\ [])
View Source@spec notebooks_projects_locations_instances_set_iam_policy( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Notebooks.V1.Model.Policy.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND
, INVALID_ARGUMENT
, and PERMISSION_DENIED
errors.
Parameters
-
connection
(type:GoogleApi.Notebooks.V1.Connection.t
) - Connection to server -
resource
(type:String.t
) - REQUIRED: The resource for which the policy is being specified. See Resource names for the appropriate value for this field. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:body
(type:GoogleApi.Notebooks.V1.Model.SetIamPolicyRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Notebooks.V1.Model.Policy{}}
on success -
{:error, info}
on failure
notebooks_projects_locations_instances_set_labels(connection, name, optional_params \\ [], opts \\ [])
View Source@spec notebooks_projects_locations_instances_set_labels( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Notebooks.V1.Model.Operation.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Replaces all the labels of an Instance.
Parameters
-
connection
(type:GoogleApi.Notebooks.V1.Connection.t
) - Connection to server -
name
(type:String.t
) - Required. Format:projects/{project_id}/locations/{location}/instances/{instance_id}
-
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:body
(type:GoogleApi.Notebooks.V1.Model.SetInstanceLabelsRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Notebooks.V1.Model.Operation{}}
on success -
{:error, info}
on failure
notebooks_projects_locations_instances_set_machine_type(connection, name, optional_params \\ [], opts \\ [])
View Source@spec notebooks_projects_locations_instances_set_machine_type( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Notebooks.V1.Model.Operation.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Updates the machine type of a single Instance.
Parameters
-
connection
(type:GoogleApi.Notebooks.V1.Connection.t
) - Connection to server -
name
(type:String.t
) - Required. Format:projects/{project_id}/locations/{location}/instances/{instance_id}
-
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:body
(type:GoogleApi.Notebooks.V1.Model.SetInstanceMachineTypeRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Notebooks.V1.Model.Operation{}}
on success -
{:error, info}
on failure
notebooks_projects_locations_instances_start(connection, name, optional_params \\ [], opts \\ [])
View Source@spec notebooks_projects_locations_instances_start( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Notebooks.V1.Model.Operation.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Starts a notebook instance.
Parameters
-
connection
(type:GoogleApi.Notebooks.V1.Connection.t
) - Connection to server -
name
(type:String.t
) - Required. Format:projects/{project_id}/locations/{location}/instances/{instance_id}
-
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:body
(type:GoogleApi.Notebooks.V1.Model.StartInstanceRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Notebooks.V1.Model.Operation{}}
on success -
{:error, info}
on failure
notebooks_projects_locations_instances_stop(connection, name, optional_params \\ [], opts \\ [])
View Source@spec notebooks_projects_locations_instances_stop( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Notebooks.V1.Model.Operation.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Stops a notebook instance.
Parameters
-
connection
(type:GoogleApi.Notebooks.V1.Connection.t
) - Connection to server -
name
(type:String.t
) - Required. Format:projects/{project_id}/locations/{location}/instances/{instance_id}
-
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:body
(type:GoogleApi.Notebooks.V1.Model.StopInstanceRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Notebooks.V1.Model.Operation{}}
on success -
{:error, info}
on failure
notebooks_projects_locations_instances_test_iam_permissions(connection, resource, optional_params \\ [], opts \\ [])
View Source@spec notebooks_projects_locations_instances_test_iam_permissions( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Notebooks.V1.Model.TestIamPermissionsResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
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.
Parameters
-
connection
(type:GoogleApi.Notebooks.V1.Connection.t
) - Connection to server -
resource
(type:String.t
) - REQUIRED: The resource for which the policy detail is being requested. See Resource names for the appropriate value for this field. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:body
(type:GoogleApi.Notebooks.V1.Model.TestIamPermissionsRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Notebooks.V1.Model.TestIamPermissionsResponse{}}
on success -
{:error, info}
on failure
notebooks_projects_locations_instances_update_config(connection, name, optional_params \\ [], opts \\ [])
View Source@spec notebooks_projects_locations_instances_update_config( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Notebooks.V1.Model.Operation.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Update Notebook Instance configurations.
Parameters
-
connection
(type:GoogleApi.Notebooks.V1.Connection.t
) - Connection to server -
name
(type:String.t
) - Required. Format:projects/{project_id}/locations/{location}/instances/{instance_id}
-
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:body
(type:GoogleApi.Notebooks.V1.Model.UpdateInstanceConfigRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Notebooks.V1.Model.Operation{}}
on success -
{:error, info}
on failure
notebooks_projects_locations_instances_update_metadata_items(connection, name, optional_params \\ [], opts \\ [])
View Source@spec notebooks_projects_locations_instances_update_metadata_items( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Notebooks.V1.Model.UpdateInstanceMetadataItemsResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Add/update metadata items for an instance.
Parameters
-
connection
(type:GoogleApi.Notebooks.V1.Connection.t
) - Connection to server -
name
(type:String.t
) - Required. Format:projects/{project_id}/locations/{location}/instances/{instance_id}
-
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:body
(type:GoogleApi.Notebooks.V1.Model.UpdateInstanceMetadataItemsRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Notebooks.V1.Model.UpdateInstanceMetadataItemsResponse{}}
on success -
{:error, info}
on failure
notebooks_projects_locations_instances_update_shielded_instance_config(connection, name, optional_params \\ [], opts \\ [])
View Source@spec notebooks_projects_locations_instances_update_shielded_instance_config( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Notebooks.V1.Model.Operation.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Updates the Shielded instance configuration of a single Instance.
Parameters
-
connection
(type:GoogleApi.Notebooks.V1.Connection.t
) - Connection to server -
name
(type:String.t
) - Required. Format:projects/{project_id}/locations/{location}/instances/{instance_id}
-
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:body
(type:GoogleApi.Notebooks.V1.Model.UpdateShieldedInstanceConfigRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Notebooks.V1.Model.Operation{}}
on success -
{:error, info}
on failure
notebooks_projects_locations_instances_upgrade(connection, name, optional_params \\ [], opts \\ [])
View Source@spec notebooks_projects_locations_instances_upgrade( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Notebooks.V1.Model.Operation.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Upgrades a notebook instance to the latest version.
Parameters
-
connection
(type:GoogleApi.Notebooks.V1.Connection.t
) - Connection to server -
name
(type:String.t
) - Required. Format:projects/{project_id}/locations/{location}/instances/{instance_id}
-
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:body
(type:GoogleApi.Notebooks.V1.Model.UpgradeInstanceRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Notebooks.V1.Model.Operation{}}
on success -
{:error, info}
on failure
notebooks_projects_locations_instances_upgrade_internal(connection, name, optional_params \\ [], opts \\ [])
View Source@spec notebooks_projects_locations_instances_upgrade_internal( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Notebooks.V1.Model.Operation.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Allows notebook instances to call this endpoint to upgrade themselves. Do not use this method directly.
Parameters
-
connection
(type:GoogleApi.Notebooks.V1.Connection.t
) - Connection to server -
name
(type:String.t
) - Required. Format:projects/{project_id}/locations/{location}/instances/{instance_id}
-
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:body
(type:GoogleApi.Notebooks.V1.Model.UpgradeInstanceInternalRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Notebooks.V1.Model.Operation{}}
on success -
{:error, info}
on failure
notebooks_projects_locations_list(connection, name, optional_params \\ [], opts \\ [])
View Source@spec notebooks_projects_locations_list( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Notebooks.V1.Model.ListLocationsResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Lists information about the supported locations for this service.
Parameters
-
connection
(type:GoogleApi.Notebooks.V1.Connection.t
) - Connection to server -
name
(type:String.t
) - The resource that owns the locations collection, if applicable. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:filter
(type:String.t
) - A filter to narrow down results to a preferred subset. The filtering language accepts strings like"displayName=tokyo"
, and is documented in more detail in AIP-160. -
:pageSize
(type:integer()
) - The maximum number of results to return. If not set, the service selects a default. -
:pageToken
(type:String.t
) - A page token received from thenext_page_token
field in the response. Send that page token to receive the subsequent page.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Notebooks.V1.Model.ListLocationsResponse{}}
on success -
{:error, info}
on failure
notebooks_projects_locations_operations_cancel(connection, name, optional_params \\ [], opts \\ [])
View Source@spec notebooks_projects_locations_operations_cancel( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Notebooks.V1.Model.Empty.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
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
.
Parameters
-
connection
(type:GoogleApi.Notebooks.V1.Connection.t
) - Connection to server -
name
(type:String.t
) - The name of the operation resource to be cancelled. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:body
(type:GoogleApi.Notebooks.V1.Model.CancelOperationRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Notebooks.V1.Model.Empty{}}
on success -
{:error, info}
on failure
notebooks_projects_locations_operations_delete(connection, name, optional_params \\ [], opts \\ [])
View Source@spec notebooks_projects_locations_operations_delete( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Notebooks.V1.Model.Empty.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
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
.
Parameters
-
connection
(type:GoogleApi.Notebooks.V1.Connection.t
) - Connection to server -
name
(type:String.t
) - The name of the operation resource to be deleted. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Notebooks.V1.Model.Empty{}}
on success -
{:error, info}
on failure
notebooks_projects_locations_operations_get(connection, name, optional_params \\ [], opts \\ [])
View Source@spec notebooks_projects_locations_operations_get( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Notebooks.V1.Model.Operation.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
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.
Parameters
-
connection
(type:GoogleApi.Notebooks.V1.Connection.t
) - Connection to server -
name
(type:String.t
) - The name of the operation resource. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Notebooks.V1.Model.Operation{}}
on success -
{:error, info}
on failure
notebooks_projects_locations_operations_list(connection, name, optional_params \\ [], opts \\ [])
View Source@spec notebooks_projects_locations_operations_list( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Notebooks.V1.Model.ListOperationsResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED
.
Parameters
-
connection
(type:GoogleApi.Notebooks.V1.Connection.t
) - Connection to server -
name
(type:String.t
) - The name of the operation's parent resource. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:filter
(type:String.t
) - The standard list filter. -
:pageSize
(type:integer()
) - The standard list page size. -
:pageToken
(type:String.t
) - The standard list page token.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Notebooks.V1.Model.ListOperationsResponse{}}
on success -
{:error, info}
on failure
notebooks_projects_locations_runtimes_create(connection, parent, optional_params \\ [], opts \\ [])
View Source@spec notebooks_projects_locations_runtimes_create( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Notebooks.V1.Model.Operation.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Creates a new Runtime in a given project and location.
Parameters
-
connection
(type:GoogleApi.Notebooks.V1.Connection.t
) - Connection to server -
parent
(type:String.t
) - Required. Format:parent=projects/{project_id}/locations/{location}
-
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:requestId
(type:String.t
) - Idempotent request UUID. -
:runtimeId
(type:String.t
) - Required. User-defined unique ID of this Runtime. -
:body
(type:GoogleApi.Notebooks.V1.Model.Runtime.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Notebooks.V1.Model.Operation{}}
on success -
{:error, info}
on failure
notebooks_projects_locations_runtimes_delete(connection, name, optional_params \\ [], opts \\ [])
View Source@spec notebooks_projects_locations_runtimes_delete( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Notebooks.V1.Model.Operation.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Deletes a single Runtime.
Parameters
-
connection
(type:GoogleApi.Notebooks.V1.Connection.t
) - Connection to server -
name
(type:String.t
) - Required. Format:projects/{project_id}/locations/{location}/runtimes/{runtime_id}
-
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:requestId
(type:String.t
) - Idempotent request UUID.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Notebooks.V1.Model.Operation{}}
on success -
{:error, info}
on failure
notebooks_projects_locations_runtimes_diagnose(connection, name, optional_params \\ [], opts \\ [])
View Source@spec notebooks_projects_locations_runtimes_diagnose( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Notebooks.V1.Model.Operation.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Creates a Diagnostic File and runs Diagnostic Tool given a Runtime.
Parameters
-
connection
(type:GoogleApi.Notebooks.V1.Connection.t
) - Connection to server -
name
(type:String.t
) - Required. Format:projects/{project_id}/locations/{location}/runtimes/{runtimes_id}
-
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:body
(type:GoogleApi.Notebooks.V1.Model.DiagnoseRuntimeRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Notebooks.V1.Model.Operation{}}
on success -
{:error, info}
on failure
notebooks_projects_locations_runtimes_get(connection, name, optional_params \\ [], opts \\ [])
View Source@spec notebooks_projects_locations_runtimes_get( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Notebooks.V1.Model.Runtime.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Gets details of a single Runtime. The location must be a regional endpoint rather than zonal.
Parameters
-
connection
(type:GoogleApi.Notebooks.V1.Connection.t
) - Connection to server -
name
(type:String.t
) - Required. Format:projects/{project_id}/locations/{location}/runtimes/{runtime_id}
-
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Notebooks.V1.Model.Runtime{}}
on success -
{:error, info}
on failure
notebooks_projects_locations_runtimes_get_iam_policy(connection, resource, optional_params \\ [], opts \\ [])
View Source@spec notebooks_projects_locations_runtimes_get_iam_policy( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Notebooks.V1.Model.Policy.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
Parameters
-
connection
(type:GoogleApi.Notebooks.V1.Connection.t
) - Connection to server -
resource
(type:String.t
) - REQUIRED: The resource for which the policy is being requested. See Resource names for the appropriate value for this field. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:"options.requestedPolicyVersion"
(type:integer()
) - Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the IAM documentation.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Notebooks.V1.Model.Policy{}}
on success -
{:error, info}
on failure
notebooks_projects_locations_runtimes_list(connection, parent, optional_params \\ [], opts \\ [])
View Source@spec notebooks_projects_locations_runtimes_list( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Notebooks.V1.Model.ListRuntimesResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Lists Runtimes in a given project and location.
Parameters
-
connection
(type:GoogleApi.Notebooks.V1.Connection.t
) - Connection to server -
parent
(type:String.t
) - Required. Format:parent=projects/{project_id}/locations/{location}
-
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:filter
(type:String.t
) - Optional. List filter. -
:orderBy
(type:String.t
) - Optional. Sort results. Supported values are "name", "name desc" or "" (unsorted). -
:pageSize
(type:integer()
) - Maximum return size of the list call. -
:pageToken
(type:String.t
) - A previous returned page token that can be used to continue listing from the last result.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Notebooks.V1.Model.ListRuntimesResponse{}}
on success -
{:error, info}
on failure
notebooks_projects_locations_runtimes_migrate(connection, name, optional_params \\ [], opts \\ [])
View Source@spec notebooks_projects_locations_runtimes_migrate( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Notebooks.V1.Model.Operation.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Migrate an existing Runtime to a new Workbench Instance.
Parameters
-
connection
(type:GoogleApi.Notebooks.V1.Connection.t
) - Connection to server -
name
(type:String.t
) - Required. Format:projects/{project_id}/locations/{location}/runtimes/{runtime_id}
-
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:body
(type:GoogleApi.Notebooks.V1.Model.MigrateRuntimeRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Notebooks.V1.Model.Operation{}}
on success -
{:error, info}
on failure
notebooks_projects_locations_runtimes_patch(connection, name, optional_params \\ [], opts \\ [])
View Source@spec notebooks_projects_locations_runtimes_patch( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Notebooks.V1.Model.Operation.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Update Notebook Runtime configuration.
Parameters
-
connection
(type:GoogleApi.Notebooks.V1.Connection.t
) - Connection to server -
name
(type:String.t
) - Output only. The resource name of the runtime. Format:projects/{project}/locations/{location}/runtimes/{runtimeId}
-
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:requestId
(type:String.t
) - Idempotent request UUID. -
:updateMask
(type:String.t
) - Required. Specifies the path, relative toRuntime
, of the field to update. For example, to change the software configuration kernels, theupdate_mask
parameter would be specified assoftware_config.kernels
, and thePATCH
request body would specify the new value, as follows: { "software_config":{ "kernels": [{ 'repository': 'gcr.io/deeplearning-platform-release/pytorch-gpu', 'tag': 'latest' }], } } Currently, only the following fields can be updated: -software_config.kernels
-software_config.post_startup_script
-software_config.custom_gpu_driver_path
-software_config.idle_shutdown
-software_config.idle_shutdown_timeout
-software_config.disable_terminal
-labels
-
:body
(type:GoogleApi.Notebooks.V1.Model.Runtime.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Notebooks.V1.Model.Operation{}}
on success -
{:error, info}
on failure
notebooks_projects_locations_runtimes_refresh_runtime_token_internal(connection, name, optional_params \\ [], opts \\ [])
View Source@spec notebooks_projects_locations_runtimes_refresh_runtime_token_internal( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Notebooks.V1.Model.RefreshRuntimeTokenInternalResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Gets an access token for the consumer service account that the customer attached to the runtime. Only accessible from the tenant instance.
Parameters
-
connection
(type:GoogleApi.Notebooks.V1.Connection.t
) - Connection to server -
name
(type:String.t
) - Required. Format:projects/{project_id}/locations/{location}/runtimes/{runtime_id}
-
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:body
(type:GoogleApi.Notebooks.V1.Model.RefreshRuntimeTokenInternalRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Notebooks.V1.Model.RefreshRuntimeTokenInternalResponse{}}
on success -
{:error, info}
on failure
notebooks_projects_locations_runtimes_report_event(connection, name, optional_params \\ [], opts \\ [])
View Source@spec notebooks_projects_locations_runtimes_report_event( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Notebooks.V1.Model.Operation.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Reports and processes a runtime event.
Parameters
-
connection
(type:GoogleApi.Notebooks.V1.Connection.t
) - Connection to server -
name
(type:String.t
) - Required. Format:projects/{project_id}/locations/{location}/runtimes/{runtime_id}
-
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:body
(type:GoogleApi.Notebooks.V1.Model.ReportRuntimeEventRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Notebooks.V1.Model.Operation{}}
on success -
{:error, info}
on failure
notebooks_projects_locations_runtimes_reset(connection, name, optional_params \\ [], opts \\ [])
View Source@spec notebooks_projects_locations_runtimes_reset( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Notebooks.V1.Model.Operation.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Resets a Managed Notebook Runtime.
Parameters
-
connection
(type:GoogleApi.Notebooks.V1.Connection.t
) - Connection to server -
name
(type:String.t
) - Required. Format:projects/{project_id}/locations/{location}/runtimes/{runtime_id}
-
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:body
(type:GoogleApi.Notebooks.V1.Model.ResetRuntimeRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Notebooks.V1.Model.Operation{}}
on success -
{:error, info}
on failure
notebooks_projects_locations_runtimes_set_iam_policy(connection, resource, optional_params \\ [], opts \\ [])
View Source@spec notebooks_projects_locations_runtimes_set_iam_policy( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Notebooks.V1.Model.Policy.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND
, INVALID_ARGUMENT
, and PERMISSION_DENIED
errors.
Parameters
-
connection
(type:GoogleApi.Notebooks.V1.Connection.t
) - Connection to server -
resource
(type:String.t
) - REQUIRED: The resource for which the policy is being specified. See Resource names for the appropriate value for this field. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:body
(type:GoogleApi.Notebooks.V1.Model.SetIamPolicyRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Notebooks.V1.Model.Policy{}}
on success -
{:error, info}
on failure
notebooks_projects_locations_runtimes_start(connection, name, optional_params \\ [], opts \\ [])
View Source@spec notebooks_projects_locations_runtimes_start( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Notebooks.V1.Model.Operation.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
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
Parameters
-
connection
(type:GoogleApi.Notebooks.V1.Connection.t
) - Connection to server -
name
(type:String.t
) - Required. Format:projects/{project_id}/locations/{location}/runtimes/{runtime_id}
-
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:body
(type:GoogleApi.Notebooks.V1.Model.StartRuntimeRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Notebooks.V1.Model.Operation{}}
on success -
{:error, info}
on failure
notebooks_projects_locations_runtimes_stop(connection, name, optional_params \\ [], opts \\ [])
View Source@spec notebooks_projects_locations_runtimes_stop( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Notebooks.V1.Model.Operation.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
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
Parameters
-
connection
(type:GoogleApi.Notebooks.V1.Connection.t
) - Connection to server -
name
(type:String.t
) - Required. Format:projects/{project_id}/locations/{location}/runtimes/{runtime_id}
-
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:body
(type:GoogleApi.Notebooks.V1.Model.StopRuntimeRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Notebooks.V1.Model.Operation{}}
on success -
{:error, info}
on failure
notebooks_projects_locations_runtimes_switch(connection, name, optional_params \\ [], opts \\ [])
View Source@spec notebooks_projects_locations_runtimes_switch( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Notebooks.V1.Model.Operation.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Switch a Managed Notebook Runtime.
Parameters
-
connection
(type:GoogleApi.Notebooks.V1.Connection.t
) - Connection to server -
name
(type:String.t
) - Required. Format:projects/{project_id}/locations/{location}/runtimes/{runtime_id}
-
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:body
(type:GoogleApi.Notebooks.V1.Model.SwitchRuntimeRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Notebooks.V1.Model.Operation{}}
on success -
{:error, info}
on failure
notebooks_projects_locations_runtimes_test_iam_permissions(connection, resource, optional_params \\ [], opts \\ [])
View Source@spec notebooks_projects_locations_runtimes_test_iam_permissions( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Notebooks.V1.Model.TestIamPermissionsResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
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.
Parameters
-
connection
(type:GoogleApi.Notebooks.V1.Connection.t
) - Connection to server -
resource
(type:String.t
) - REQUIRED: The resource for which the policy detail is being requested. See Resource names for the appropriate value for this field. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:body
(type:GoogleApi.Notebooks.V1.Model.TestIamPermissionsRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Notebooks.V1.Model.TestIamPermissionsResponse{}}
on success -
{:error, info}
on failure
notebooks_projects_locations_runtimes_upgrade(connection, name, optional_params \\ [], opts \\ [])
View Source@spec notebooks_projects_locations_runtimes_upgrade( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Notebooks.V1.Model.Operation.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Upgrades a Managed Notebook Runtime to the latest version.
Parameters
-
connection
(type:GoogleApi.Notebooks.V1.Connection.t
) - Connection to server -
name
(type:String.t
) - Required. Format:projects/{project_id}/locations/{location}/runtimes/{runtime_id}
-
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:body
(type:GoogleApi.Notebooks.V1.Model.UpgradeRuntimeRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Notebooks.V1.Model.Operation{}}
on success -
{:error, info}
on failure
notebooks_projects_locations_schedules_create(connection, parent, optional_params \\ [], opts \\ [])
View Source@spec notebooks_projects_locations_schedules_create( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Notebooks.V1.Model.Operation.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Creates a new Scheduled Notebook in a given project and location.
Parameters
-
connection
(type:GoogleApi.Notebooks.V1.Connection.t
) - Connection to server -
parent
(type:String.t
) - Required. Format:parent=projects/{project_id}/locations/{location}
-
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:scheduleId
(type:String.t
) - Required. User-defined unique ID of this schedule. -
:body
(type:GoogleApi.Notebooks.V1.Model.Schedule.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Notebooks.V1.Model.Operation{}}
on success -
{:error, info}
on failure
notebooks_projects_locations_schedules_delete(connection, name, optional_params \\ [], opts \\ [])
View Source@spec notebooks_projects_locations_schedules_delete( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Notebooks.V1.Model.Operation.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Deletes schedule and all underlying jobs
Parameters
-
connection
(type:GoogleApi.Notebooks.V1.Connection.t
) - Connection to server -
name
(type:String.t
) - Required. Format:projects/{project_id}/locations/{location}/schedules/{schedule_id}
-
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Notebooks.V1.Model.Operation{}}
on success -
{:error, info}
on failure
notebooks_projects_locations_schedules_get(connection, name, optional_params \\ [], opts \\ [])
View Source@spec notebooks_projects_locations_schedules_get( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Notebooks.V1.Model.Schedule.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Gets details of schedule
Parameters
-
connection
(type:GoogleApi.Notebooks.V1.Connection.t
) - Connection to server -
name
(type:String.t
) - Required. Format:projects/{project_id}/locations/{location}/schedules/{schedule_id}
-
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Notebooks.V1.Model.Schedule{}}
on success -
{:error, info}
on failure
notebooks_projects_locations_schedules_list(connection, parent, optional_params \\ [], opts \\ [])
View Source@spec notebooks_projects_locations_schedules_list( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Notebooks.V1.Model.ListSchedulesResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Lists schedules in a given project and location.
Parameters
-
connection
(type:GoogleApi.Notebooks.V1.Connection.t
) - Connection to server -
parent
(type:String.t
) - Required. Format:parent=projects/{project_id}/locations/{location}
-
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:filter
(type:String.t
) - Filter applied to resulting schedules. -
:orderBy
(type:String.t
) - Field to order results by. -
:pageSize
(type:integer()
) - Maximum return size of the list call. -
:pageToken
(type:String.t
) - A previous returned page token that can be used to continue listing from the last result.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Notebooks.V1.Model.ListSchedulesResponse{}}
on success -
{:error, info}
on failure
notebooks_projects_locations_schedules_trigger(connection, name, optional_params \\ [], opts \\ [])
View Source@spec notebooks_projects_locations_schedules_trigger( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Notebooks.V1.Model.Operation.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Triggers execution of an existing schedule.
Parameters
-
connection
(type:GoogleApi.Notebooks.V1.Connection.t
) - Connection to server -
name
(type:String.t
) - Required. Format:parent=projects/{project_id}/locations/{location}/schedules/{schedule_id}
-
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:body
(type:GoogleApi.Notebooks.V1.Model.TriggerScheduleRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Notebooks.V1.Model.Operation{}}
on success -
{:error, info}
on failure