Struct google_notebooks1::api::ProjectMethods

source ·

pub struct ProjectMethods<'a, S>where
    S: 'a,
{ /* private fields */ }

Expand description

A builder providing access to all methods supported on project resources. It is not used directly, but through the AIPlatformNotebooks hub.

§Example

Instantiate a resource builder

extern crate hyper;
extern crate hyper_rustls;
extern crate google_notebooks1 as notebooks1;
 
use std::default::Default;
use notebooks1::{AIPlatformNotebooks, oauth2, hyper, hyper_rustls, chrono, FieldMask};
 
let secret: oauth2::ApplicationSecret = Default::default();
let auth = oauth2::InstalledFlowAuthenticator::builder(
        secret,
        oauth2::InstalledFlowReturnMethod::HTTPRedirect,
    ).build().await.unwrap();
let mut hub = AIPlatformNotebooks::new(hyper::Client::builder().build(hyper_rustls::HttpsConnectorBuilder::new().with_native_roots().https_or_http().enable_http1().build()), auth);
// Usually you wouldn't bind this to a variable, but keep calling *CallBuilders*
// like `locations_environments_create(...)`, `locations_environments_delete(...)`, `locations_environments_get(...)`, `locations_environments_list(...)`, `locations_executions_create(...)`, `locations_executions_delete(...)`, `locations_executions_get(...)`, `locations_executions_list(...)`, `locations_get(...)`, `locations_instances_create(...)`, `locations_instances_delete(...)`, `locations_instances_diagnose(...)`, `locations_instances_get(...)`, `locations_instances_get_iam_policy(...)`, `locations_instances_get_instance_health(...)`, `locations_instances_is_upgradeable(...)`, `locations_instances_list(...)`, `locations_instances_migrate(...)`, `locations_instances_register(...)`, `locations_instances_report(...)`, `locations_instances_report_event(...)`, `locations_instances_reset(...)`, `locations_instances_rollback(...)`, `locations_instances_set_accelerator(...)`, `locations_instances_set_iam_policy(...)`, `locations_instances_set_labels(...)`, `locations_instances_set_machine_type(...)`, `locations_instances_start(...)`, `locations_instances_stop(...)`, `locations_instances_test_iam_permissions(...)`, `locations_instances_update_config(...)`, `locations_instances_update_metadata_items(...)`, `locations_instances_update_shielded_instance_config(...)`, `locations_instances_upgrade(...)`, `locations_instances_upgrade_internal(...)`, `locations_list(...)`, `locations_operations_cancel(...)`, `locations_operations_delete(...)`, `locations_operations_get(...)`, `locations_operations_list(...)`, `locations_runtimes_create(...)`, `locations_runtimes_delete(...)`, `locations_runtimes_diagnose(...)`, `locations_runtimes_get(...)`, `locations_runtimes_get_iam_policy(...)`, `locations_runtimes_list(...)`, `locations_runtimes_migrate(...)`, `locations_runtimes_patch(...)`, `locations_runtimes_refresh_runtime_token_internal(...)`, `locations_runtimes_report_event(...)`, `locations_runtimes_reset(...)`, `locations_runtimes_set_iam_policy(...)`, `locations_runtimes_start(...)`, `locations_runtimes_stop(...)`, `locations_runtimes_switch(...)`, `locations_runtimes_test_iam_permissions(...)`, `locations_runtimes_upgrade(...)`, `locations_schedules_create(...)`, `locations_schedules_delete(...)`, `locations_schedules_get(...)`, `locations_schedules_list(...)` and `locations_schedules_trigger(...)`
// to build up your call.
let rb = hub.projects();

Implementations§

source §

impl<'a, S> ProjectMethods<'a, S>

source

pub fn locations_environments_create( &self, request: Environment, parent: &str ) -> ProjectLocationEnvironmentCreateCall<'a, S>

Create a builder to help you perform the following task:

Creates a new Environment.

§Arguments

request - No description provided.
parent - Required. Format: projects/{project_id}/locations/{location}

source

pub fn locations_environments_delete( &self, name: &str ) -> ProjectLocationEnvironmentDeleteCall<'a, S>

Create a builder to help you perform the following task:

Deletes a single Environment.

§Arguments

name - Required. Format: projects/{project_id}/locations/{location}/environments/{environment_id}

source

pub fn locations_environments_get( &self, name: &str ) -> ProjectLocationEnvironmentGetCall<'a, S>

Create a builder to help you perform the following task:

Gets details of a single Environment.

§Arguments

name - Required. Format: projects/{project_id}/locations/{location}/environments/{environment_id}

source

pub fn locations_environments_list( &self, parent: &str ) -> ProjectLocationEnvironmentListCall<'a, S>

Create a builder to help you perform the following task:

Lists environments in a project.

§Arguments

parent - Required. Format: projects/{project_id}/locations/{location}

source

pub fn locations_executions_create( &self, request: Execution, parent: &str ) -> ProjectLocationExecutionCreateCall<'a, S>

Create a builder to help you perform the following task:

Creates a new Execution in a given project and location.

§Arguments

request - No description provided.
parent - Required. Format: parent=projects/{project_id}/locations/{location}

source

pub fn locations_executions_delete( &self, name: &str ) -> ProjectLocationExecutionDeleteCall<'a, S>

Create a builder to help you perform the following task:

Deletes execution

§Arguments

name - Required. Format: projects/{project_id}/locations/{location}/executions/{execution_id}

source

pub fn locations_executions_get( &self, name: &str ) -> ProjectLocationExecutionGetCall<'a, S>

Create a builder to help you perform the following task:

Gets details of executions

§Arguments

name - Required. Format: projects/{project_id}/locations/{location}/executions/{execution_id}

source

pub fn locations_executions_list( &self, parent: &str ) -> ProjectLocationExecutionListCall<'a, S>

Create a builder to help you perform the following task:

Lists executions in a given project and location

§Arguments

parent - Required. Format: parent=projects/{project_id}/locations/{location}

source

pub fn locations_instances_create( &self, request: Instance, parent: &str ) -> ProjectLocationInstanceCreateCall<'a, S>

Create a builder to help you perform the following task:

Creates a new Instance in a given project and location.

§Arguments

request - No description provided.
parent - Required. Format: parent=projects/{project_id}/locations/{location}

source

pub fn locations_instances_delete( &self, name: &str ) -> ProjectLocationInstanceDeleteCall<'a, S>

Create a builder to help you perform the following task:

Deletes a single Instance.

§Arguments

name - Required. Format: projects/{project_id}/locations/{location}/instances/{instance_id}

source

pub fn locations_instances_diagnose( &self, request: DiagnoseInstanceRequest, name: &str ) -> ProjectLocationInstanceDiagnoseCall<'a, S>

Create a builder to help you perform the following task:

Creates a Diagnostic File and runs Diagnostic Tool given an Instance.

§Arguments

request - No description provided.
name - Required. Format: projects/{project_id}/locations/{location}/instances/{instance_id}

source

pub fn locations_instances_get( &self, name: &str ) -> ProjectLocationInstanceGetCall<'a, S>

Create a builder to help you perform the following task:

Gets details of a single Instance.

§Arguments

name - Required. Format: projects/{project_id}/locations/{location}/instances/{instance_id}

source

pub fn locations_instances_get_iam_policy( &self, resource: &str ) -> ProjectLocationInstanceGetIamPolicyCall<'a, S>

Create a builder to help you perform the following task:

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

§Arguments

resource - REQUIRED: The resource for which the policy is being requested. See Resource names for the appropriate value for this field.

source

pub fn locations_instances_get_instance_health( &self, name: &str ) -> ProjectLocationInstanceGetInstanceHealthCall<'a, S>

Create a builder to help you perform the following task:

Checks whether a notebook instance is healthy.

§Arguments

name - Required. Format: projects/{project_id}/locations/{location}/instances/{instance_id}

source

pub fn locations_instances_is_upgradeable( &self, notebook_instance: &str ) -> ProjectLocationInstanceIsUpgradeableCall<'a, S>

Create a builder to help you perform the following task:

Checks whether a notebook instance is upgradable.

§Arguments

notebookInstance - Required. Format: projects/{project_id}/locations/{location}/instances/{instance_id}

source

pub fn locations_instances_list( &self, parent: &str ) -> ProjectLocationInstanceListCall<'a, S>

Create a builder to help you perform the following task:

Lists instances in a given project and location.

§Arguments

parent - Required. Format: parent=projects/{project_id}/locations/{location}

source

pub fn locations_instances_migrate( &self, request: MigrateInstanceRequest, name: &str ) -> ProjectLocationInstanceMigrateCall<'a, S>

Create a builder to help you perform the following task:

Migrates an existing User-Managed Notebook to Workbench Instances.

§Arguments

request - No description provided.
name - Required. Format: projects/{project_id}/locations/{location}/instances/{instance_id}

source

pub fn locations_instances_register( &self, request: RegisterInstanceRequest, parent: &str ) -> ProjectLocationInstanceRegisterCall<'a, S>

Create a builder to help you perform the following task:

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.

§Arguments

request - No description provided.
parent - Required. Format: parent=projects/{project_id}/locations/{location}

source

pub fn locations_instances_report( &self, request: ReportInstanceInfoRequest, name: &str ) -> ProjectLocationInstanceReportCall<'a, S>

Create a builder to help you perform the following task:

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.

§Arguments

request - No description provided.
name - Required. Format: projects/{project_id}/locations/{location}/instances/{instance_id}

source

pub fn locations_instances_report_event( &self, request: ReportInstanceEventRequest, name: &str ) -> ProjectLocationInstanceReportEventCall<'a, S>

Create a builder to help you perform the following task:

Reports and processes an instance event.

§Arguments

request - No description provided.
name - Required. Format: projects/{project_id}/locations/{location}/instances/{instance_id}

source

pub fn locations_instances_reset( &self, request: ResetInstanceRequest, name: &str ) -> ProjectLocationInstanceResetCall<'a, S>

Create a builder to help you perform the following task:

Resets a notebook instance.

§Arguments

request - No description provided.
name - Required. Format: projects/{project_id}/locations/{location}/instances/{instance_id}

source

pub fn locations_instances_rollback( &self, request: RollbackInstanceRequest, name: &str ) -> ProjectLocationInstanceRollbackCall<'a, S>

Create a builder to help you perform the following task:

Rollbacks a notebook instance to the previous version.

§Arguments

request - No description provided.
name - Required. Format: projects/{project_id}/locations/{location}/instances/{instance_id}

source

pub fn locations_instances_set_accelerator( &self, request: SetInstanceAcceleratorRequest, name: &str ) -> ProjectLocationInstanceSetAcceleratorCall<'a, S>

Create a builder to help you perform the following task:

Updates the guest accelerators of a single Instance.

§Arguments

request - No description provided.
name - Required. Format: projects/{project_id}/locations/{location}/instances/{instance_id}

source

pub fn locations_instances_set_iam_policy( &self, request: SetIamPolicyRequest, resource: &str ) -> ProjectLocationInstanceSetIamPolicyCall<'a, S>

Create a builder to help you perform the following task:

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

§Arguments

request - No description provided.
resource - REQUIRED: The resource for which the policy is being specified. See Resource names for the appropriate value for this field.

source

pub fn locations_instances_set_labels( &self, request: SetInstanceLabelsRequest, name: &str ) -> ProjectLocationInstanceSetLabelCall<'a, S>

Create a builder to help you perform the following task:

Replaces all the labels of an Instance.

§Arguments

request - No description provided.
name - Required. Format: projects/{project_id}/locations/{location}/instances/{instance_id}

source

pub fn locations_instances_set_machine_type( &self, request: SetInstanceMachineTypeRequest, name: &str ) -> ProjectLocationInstanceSetMachineTypeCall<'a, S>

Create a builder to help you perform the following task:

Updates the machine type of a single Instance.

§Arguments

request - No description provided.
name - Required. Format: projects/{project_id}/locations/{location}/instances/{instance_id}

source

pub fn locations_instances_start( &self, request: StartInstanceRequest, name: &str ) -> ProjectLocationInstanceStartCall<'a, S>

Create a builder to help you perform the following task:

Starts a notebook instance.

§Arguments

request - No description provided.
name - Required. Format: projects/{project_id}/locations/{location}/instances/{instance_id}

source

pub fn locations_instances_stop( &self, request: StopInstanceRequest, name: &str ) -> ProjectLocationInstanceStopCall<'a, S>

Create a builder to help you perform the following task:

Stops a notebook instance.

§Arguments

request - No description provided.
name - Required. Format: projects/{project_id}/locations/{location}/instances/{instance_id}

source

pub fn locations_instances_test_iam_permissions( &self, request: TestIamPermissionsRequest, resource: &str ) -> ProjectLocationInstanceTestIamPermissionCall<'a, S>

Create a builder to help you perform the following task:

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.

§Arguments

request - No description provided.
resource - REQUIRED: The resource for which the policy detail is being requested. See Resource names for the appropriate value for this field.

source

pub fn locations_instances_update_config( &self, request: UpdateInstanceConfigRequest, name: &str ) -> ProjectLocationInstanceUpdateConfigCall<'a, S>

Create a builder to help you perform the following task:

Update Notebook Instance configurations.

§Arguments

request - No description provided.
name - Required. Format: projects/{project_id}/locations/{location}/instances/{instance_id}

source

pub fn locations_instances_update_metadata_items( &self, request: UpdateInstanceMetadataItemsRequest, name: &str ) -> ProjectLocationInstanceUpdateMetadataItemCall<'a, S>

Create a builder to help you perform the following task:

Add/update metadata items for an instance.

§Arguments

request - No description provided.
name - Required. Format: projects/{project_id}/locations/{location}/instances/{instance_id}

source

pub fn locations_instances_update_shielded_instance_config( &self, request: UpdateShieldedInstanceConfigRequest, name: &str ) -> ProjectLocationInstanceUpdateShieldedInstanceConfigCall<'a, S>

Create a builder to help you perform the following task:

Updates the Shielded instance configuration of a single Instance.

§Arguments

request - No description provided.
name - Required. Format: projects/{project_id}/locations/{location}/instances/{instance_id}

source

pub fn locations_instances_upgrade( &self, request: UpgradeInstanceRequest, name: &str ) -> ProjectLocationInstanceUpgradeCall<'a, S>

Create a builder to help you perform the following task:

Upgrades a notebook instance to the latest version.

§Arguments

request - No description provided.
name - Required. Format: projects/{project_id}/locations/{location}/instances/{instance_id}

source

pub fn locations_instances_upgrade_internal( &self, request: UpgradeInstanceInternalRequest, name: &str ) -> ProjectLocationInstanceUpgradeInternalCall<'a, S>

Create a builder to help you perform the following task:

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

§Arguments

request - No description provided.
name - Required. Format: projects/{project_id}/locations/{location}/instances/{instance_id}

source

pub fn locations_operations_cancel( &self, request: CancelOperationRequest, name: &str ) -> ProjectLocationOperationCancelCall<'a, S>

Create a builder to help you perform the following task:

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.

§Arguments

request - No description provided.
name - The name of the operation resource to be cancelled.

source

pub fn locations_operations_delete( &self, name: &str ) -> ProjectLocationOperationDeleteCall<'a, S>

Create a builder to help you perform the following task:

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.

§Arguments

name - The name of the operation resource to be deleted.

source

pub fn locations_operations_get( &self, name: &str ) -> ProjectLocationOperationGetCall<'a, S>

Create a builder to help you perform the following task:

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.

§Arguments

name - The name of the operation resource.

source

pub fn locations_operations_list( &self, name: &str ) -> ProjectLocationOperationListCall<'a, S>

Create a builder to help you perform the following task:

Lists operations that match the specified filter in the request. If the server doesn’t support this method, it returns UNIMPLEMENTED.

§Arguments

name - The name of the operation’s parent resource.

source

pub fn locations_runtimes_create( &self, request: Runtime, parent: &str ) -> ProjectLocationRuntimeCreateCall<'a, S>

Create a builder to help you perform the following task:

Creates a new Runtime in a given project and location.

§Arguments

request - No description provided.
parent - Required. Format: parent=projects/{project_id}/locations/{location}

source

pub fn locations_runtimes_delete( &self, name: &str ) -> ProjectLocationRuntimeDeleteCall<'a, S>

Create a builder to help you perform the following task:

Deletes a single Runtime.

§Arguments

name - Required. Format: projects/{project_id}/locations/{location}/runtimes/{runtime_id}

source

pub fn locations_runtimes_diagnose( &self, request: DiagnoseRuntimeRequest, name: &str ) -> ProjectLocationRuntimeDiagnoseCall<'a, S>

Create a builder to help you perform the following task:

Creates a Diagnostic File and runs Diagnostic Tool given a Runtime.

§Arguments

request - No description provided.
name - Required. Format: projects/{project_id}/locations/{location}/runtimes/{runtimes_id}

source

pub fn locations_runtimes_get( &self, name: &str ) -> ProjectLocationRuntimeGetCall<'a, S>

Create a builder to help you perform the following task:

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

§Arguments

name - Required. Format: projects/{project_id}/locations/{location}/runtimes/{runtime_id}

source

pub fn locations_runtimes_get_iam_policy( &self, resource: &str ) -> ProjectLocationRuntimeGetIamPolicyCall<'a, S>

Create a builder to help you perform the following task:

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

§Arguments

resource - REQUIRED: The resource for which the policy is being requested. See Resource names for the appropriate value for this field.

source

pub fn locations_runtimes_list( &self, parent: &str ) -> ProjectLocationRuntimeListCall<'a, S>

Create a builder to help you perform the following task:

Lists Runtimes in a given project and location.

§Arguments

parent - Required. Format: parent=projects/{project_id}/locations/{location}

source

pub fn locations_runtimes_migrate( &self, request: MigrateRuntimeRequest, name: &str ) -> ProjectLocationRuntimeMigrateCall<'a, S>

Create a builder to help you perform the following task:

Migrate an existing Runtime to a new Workbench Instance.

§Arguments

request - No description provided.
name - Required. Format: projects/{project_id}/locations/{location}/runtimes/{runtime_id}

source

pub fn locations_runtimes_patch( &self, request: Runtime, name: &str ) -> ProjectLocationRuntimePatchCall<'a, S>

Create a builder to help you perform the following task:

Update Notebook Runtime configuration.

§Arguments

request - No description provided.
name - Output only. The resource name of the runtime. Format: projects/{project}/locations/{location}/runtimes/{runtimeId}

source

pub fn locations_runtimes_refresh_runtime_token_internal( &self, request: RefreshRuntimeTokenInternalRequest, name: &str ) -> ProjectLocationRuntimeRefreshRuntimeTokenInternalCall<'a, S>

Create a builder to help you perform the following task:

Gets an access token for the consumer service account that the customer attached to the runtime. Only accessible from the tenant instance.

§Arguments

request - No description provided.
name - Required. Format: projects/{project_id}/locations/{location}/runtimes/{runtime_id}

source

pub fn locations_runtimes_report_event( &self, request: ReportRuntimeEventRequest, name: &str ) -> ProjectLocationRuntimeReportEventCall<'a, S>

Create a builder to help you perform the following task:

Reports and processes a runtime event.

§Arguments

request - No description provided.
name - Required. Format: projects/{project_id}/locations/{location}/runtimes/{runtime_id}

source

pub fn locations_runtimes_reset( &self, request: ResetRuntimeRequest, name: &str ) -> ProjectLocationRuntimeResetCall<'a, S>

Create a builder to help you perform the following task:

Resets a Managed Notebook Runtime.

§Arguments

request - No description provided.
name - Required. Format: projects/{project_id}/locations/{location}/runtimes/{runtime_id}

source

pub fn locations_runtimes_set_iam_policy( &self, request: SetIamPolicyRequest, resource: &str ) -> ProjectLocationRuntimeSetIamPolicyCall<'a, S>

Create a builder to help you perform the following task:

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

§Arguments

request - No description provided.
resource - REQUIRED: The resource for which the policy is being specified. See Resource names for the appropriate value for this field.

source

pub fn locations_runtimes_start( &self, request: StartRuntimeRequest, name: &str ) -> ProjectLocationRuntimeStartCall<'a, S>

Create a builder to help you perform the following task:

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

§Arguments

request - No description provided.
name - Required. Format: projects/{project_id}/locations/{location}/runtimes/{runtime_id}

source

pub fn locations_runtimes_stop( &self, request: StopRuntimeRequest, name: &str ) -> ProjectLocationRuntimeStopCall<'a, S>

Create a builder to help you perform the following task:

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

§Arguments

request - No description provided.
name - Required. Format: projects/{project_id}/locations/{location}/runtimes/{runtime_id}

source

pub fn locations_runtimes_switch( &self, request: SwitchRuntimeRequest, name: &str ) -> ProjectLocationRuntimeSwitchCall<'a, S>

Create a builder to help you perform the following task:

Switch a Managed Notebook Runtime.

§Arguments

request - No description provided.
name - Required. Format: projects/{project_id}/locations/{location}/runtimes/{runtime_id}

source

pub fn locations_runtimes_test_iam_permissions( &self, request: TestIamPermissionsRequest, resource: &str ) -> ProjectLocationRuntimeTestIamPermissionCall<'a, S>

Create a builder to help you perform the following task:

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.

§Arguments

request - No description provided.
resource - REQUIRED: The resource for which the policy detail is being requested. See Resource names for the appropriate value for this field.

source