// Copyright 2025 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// https://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
// Generated code. DO NOT EDIT!
namespace Google.Apis.AIPlatformNotebooks.v1
{
/// The AIPlatformNotebooks Service.
public class AIPlatformNotebooksService : Google.Apis.Services.BaseClientService
{
/// The API version.
public const string Version = "v1";
/// The discovery version used to generate this service.
public static Google.Apis.Discovery.DiscoveryVersion DiscoveryVersionUsed = Google.Apis.Discovery.DiscoveryVersion.Version_1_0;
/// Constructs a new service.
public AIPlatformNotebooksService() : this(new Google.Apis.Services.BaseClientService.Initializer())
{
}
/// Constructs a new service.
/// The service initializer.
public AIPlatformNotebooksService(Google.Apis.Services.BaseClientService.Initializer initializer) : base(initializer)
{
Projects = new ProjectsResource(this);
BaseUri = GetEffectiveUri(BaseUriOverride, "https://notebooks.googleapis.com/");
BatchUri = GetEffectiveUri(null, "https://notebooks.googleapis.com/batch");
}
/// Gets the service supported features.
public override System.Collections.Generic.IList Features => new string[0];
/// Gets the service name.
public override string Name => "notebooks";
/// Gets the service base URI.
public override string BaseUri { get; }
/// Gets the service base path.
public override string BasePath => "";
/// Gets the batch base URI; null if unspecified.
public override string BatchUri { get; }
/// Gets the batch base path; null if unspecified.
public override string BatchPath => "batch";
/// Available OAuth 2.0 scopes for use with the Notebooks API.
public class Scope
{
///
/// See, edit, configure, and delete your Google Cloud data and see the email address for your Google
/// Account.
///
public static string CloudPlatform = "https://www.googleapis.com/auth/cloud-platform";
}
/// Available OAuth 2.0 scope constants for use with the Notebooks API.
public static class ScopeConstants
{
///
/// See, edit, configure, and delete your Google Cloud data and see the email address for your Google
/// Account.
///
public const string CloudPlatform = "https://www.googleapis.com/auth/cloud-platform";
}
/// Gets the Projects resource.
public virtual ProjectsResource Projects { get; }
}
/// A base abstract class for AIPlatformNotebooks requests.
public abstract class AIPlatformNotebooksBaseServiceRequest : Google.Apis.Requests.ClientServiceRequest
{
/// Constructs a new AIPlatformNotebooksBaseServiceRequest instance.
protected AIPlatformNotebooksBaseServiceRequest(Google.Apis.Services.IClientService service) : base(service)
{
}
/// V1 error format.
[Google.Apis.Util.RequestParameterAttribute("$.xgafv", Google.Apis.Util.RequestParameterType.Query)]
public virtual System.Nullable Xgafv { get; set; }
/// V1 error format.
public enum XgafvEnum
{
/// v1 error format
[Google.Apis.Util.StringValueAttribute("1")]
Value1 = 0,
/// v2 error format
[Google.Apis.Util.StringValueAttribute("2")]
Value2 = 1,
}
/// OAuth access token.
[Google.Apis.Util.RequestParameterAttribute("access_token", Google.Apis.Util.RequestParameterType.Query)]
public virtual string AccessToken { get; set; }
/// Data format for response.
[Google.Apis.Util.RequestParameterAttribute("alt", Google.Apis.Util.RequestParameterType.Query)]
public virtual System.Nullable Alt { get; set; }
/// Data format for response.
public enum AltEnum
{
/// Responses with Content-Type of application/json
[Google.Apis.Util.StringValueAttribute("json")]
Json = 0,
/// Media download with context-dependent Content-Type
[Google.Apis.Util.StringValueAttribute("media")]
Media = 1,
/// Responses with Content-Type of application/x-protobuf
[Google.Apis.Util.StringValueAttribute("proto")]
Proto = 2,
}
/// JSONP
[Google.Apis.Util.RequestParameterAttribute("callback", Google.Apis.Util.RequestParameterType.Query)]
public virtual string Callback { get; set; }
/// Selector specifying which fields to include in a partial response.
[Google.Apis.Util.RequestParameterAttribute("fields", Google.Apis.Util.RequestParameterType.Query)]
public virtual string Fields { get; set; }
///
/// 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.
///
[Google.Apis.Util.RequestParameterAttribute("key", Google.Apis.Util.RequestParameterType.Query)]
public virtual string Key { get; set; }
/// OAuth 2.0 token for the current user.
[Google.Apis.Util.RequestParameterAttribute("oauth_token", Google.Apis.Util.RequestParameterType.Query)]
public virtual string OauthToken { get; set; }
/// Returns response with indentations and line breaks.
[Google.Apis.Util.RequestParameterAttribute("prettyPrint", Google.Apis.Util.RequestParameterType.Query)]
public virtual System.Nullable PrettyPrint { get; set; }
///
/// 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.
///
[Google.Apis.Util.RequestParameterAttribute("quotaUser", Google.Apis.Util.RequestParameterType.Query)]
public virtual string QuotaUser { get; set; }
/// Legacy upload protocol for media (e.g. "media", "multipart").
[Google.Apis.Util.RequestParameterAttribute("uploadType", Google.Apis.Util.RequestParameterType.Query)]
public virtual string UploadType { get; set; }
/// Upload protocol for media (e.g. "raw", "multipart").
[Google.Apis.Util.RequestParameterAttribute("upload_protocol", Google.Apis.Util.RequestParameterType.Query)]
public virtual string UploadProtocol { get; set; }
/// Initializes AIPlatformNotebooks parameter list.
protected override void InitParameters()
{
base.InitParameters();
RequestParameters.Add("$.xgafv", new Google.Apis.Discovery.Parameter
{
Name = "$.xgafv",
IsRequired = false,
ParameterType = "query",
DefaultValue = null,
Pattern = null,
});
RequestParameters.Add("access_token", new Google.Apis.Discovery.Parameter
{
Name = "access_token",
IsRequired = false,
ParameterType = "query",
DefaultValue = null,
Pattern = null,
});
RequestParameters.Add("alt", new Google.Apis.Discovery.Parameter
{
Name = "alt",
IsRequired = false,
ParameterType = "query",
DefaultValue = "json",
Pattern = null,
});
RequestParameters.Add("callback", new Google.Apis.Discovery.Parameter
{
Name = "callback",
IsRequired = false,
ParameterType = "query",
DefaultValue = null,
Pattern = null,
});
RequestParameters.Add("fields", new Google.Apis.Discovery.Parameter
{
Name = "fields",
IsRequired = false,
ParameterType = "query",
DefaultValue = null,
Pattern = null,
});
RequestParameters.Add("key", new Google.Apis.Discovery.Parameter
{
Name = "key",
IsRequired = false,
ParameterType = "query",
DefaultValue = null,
Pattern = null,
});
RequestParameters.Add("oauth_token", new Google.Apis.Discovery.Parameter
{
Name = "oauth_token",
IsRequired = false,
ParameterType = "query",
DefaultValue = null,
Pattern = null,
});
RequestParameters.Add("prettyPrint", new Google.Apis.Discovery.Parameter
{
Name = "prettyPrint",
IsRequired = false,
ParameterType = "query",
DefaultValue = "true",
Pattern = null,
});
RequestParameters.Add("quotaUser", new Google.Apis.Discovery.Parameter
{
Name = "quotaUser",
IsRequired = false,
ParameterType = "query",
DefaultValue = null,
Pattern = null,
});
RequestParameters.Add("uploadType", new Google.Apis.Discovery.Parameter
{
Name = "uploadType",
IsRequired = false,
ParameterType = "query",
DefaultValue = null,
Pattern = null,
});
RequestParameters.Add("upload_protocol", new Google.Apis.Discovery.Parameter
{
Name = "upload_protocol",
IsRequired = false,
ParameterType = "query",
DefaultValue = null,
Pattern = null,
});
}
}
/// The "projects" collection of methods.
public class ProjectsResource
{
private const string Resource = "projects";
/// The service which this resource belongs to.
private readonly Google.Apis.Services.IClientService service;
/// Constructs a new resource.
public ProjectsResource(Google.Apis.Services.IClientService service)
{
this.service = service;
Locations = new LocationsResource(service);
}
/// Gets the Locations resource.
public virtual LocationsResource Locations { get; }
/// The "locations" collection of methods.
public class LocationsResource
{
private const string Resource = "locations";
/// The service which this resource belongs to.
private readonly Google.Apis.Services.IClientService service;
/// Constructs a new resource.
public LocationsResource(Google.Apis.Services.IClientService service)
{
this.service = service;
Environments = new EnvironmentsResource(service);
Executions = new ExecutionsResource(service);
Instances = new InstancesResource(service);
Operations = new OperationsResource(service);
Runtimes = new RuntimesResource(service);
Schedules = new SchedulesResource(service);
}
/// Gets the Environments resource.
public virtual EnvironmentsResource Environments { get; }
/// The "environments" collection of methods.
public class EnvironmentsResource
{
private const string Resource = "environments";
/// The service which this resource belongs to.
private readonly Google.Apis.Services.IClientService service;
/// Constructs a new resource.
public EnvironmentsResource(Google.Apis.Services.IClientService service)
{
this.service = service;
}
/// Creates a new Environment.
/// The body of the request.
/// Required. Format: `projects/{project_id}/locations/{location}`
public virtual CreateRequest Create(Google.Apis.AIPlatformNotebooks.v1.Data.Environment body, string parent)
{
return new CreateRequest(this.service, body, parent);
}
/// Creates a new Environment.
public class CreateRequest : AIPlatformNotebooksBaseServiceRequest
{
/// Constructs a new Create request.
public CreateRequest(Google.Apis.Services.IClientService service, Google.Apis.AIPlatformNotebooks.v1.Data.Environment body, string parent) : base(service)
{
Parent = parent;
Body = body;
InitParameters();
}
/// Required. Format: `projects/{project_id}/locations/{location}`
[Google.Apis.Util.RequestParameterAttribute("parent", Google.Apis.Util.RequestParameterType.Path)]
public virtual string Parent { get; private set; }
///
/// Required. User-defined unique ID of this environment. The `environment_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.
///
[Google.Apis.Util.RequestParameterAttribute("environmentId", Google.Apis.Util.RequestParameterType.Query)]
public virtual string EnvironmentId { get; set; }
/// Gets or sets the body of this request.
Google.Apis.AIPlatformNotebooks.v1.Data.Environment Body { get; set; }
/// Returns the body of the request.
protected override object GetBody() => Body;
/// Gets the method name.
public override string MethodName => "create";
/// Gets the HTTP method.
public override string HttpMethod => "POST";
/// Gets the REST path.
public override string RestPath => "v1/{+parent}/environments";
/// Initializes Create parameter list.
protected override void InitParameters()
{
base.InitParameters();
RequestParameters.Add("parent", new Google.Apis.Discovery.Parameter
{
Name = "parent",
IsRequired = true,
ParameterType = "path",
DefaultValue = null,
Pattern = @"^projects/[^/]+/locations/[^/]+$",
});
RequestParameters.Add("environmentId", new Google.Apis.Discovery.Parameter
{
Name = "environmentId",
IsRequired = false,
ParameterType = "query",
DefaultValue = null,
Pattern = null,
});
}
}
/// Deletes a single Environment.
///
/// Required. Format: `projects/{project_id}/locations/{location}/environments/{environment_id}`
///
public virtual DeleteRequest Delete(string name)
{
return new DeleteRequest(this.service, name);
}
/// Deletes a single Environment.
public class DeleteRequest : AIPlatformNotebooksBaseServiceRequest
{
/// Constructs a new Delete request.
public DeleteRequest(Google.Apis.Services.IClientService service, string name) : base(service)
{
Name = name;
InitParameters();
}
///
/// Required. Format: `projects/{project_id}/locations/{location}/environments/{environment_id}`
///
[Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)]
public virtual string Name { get; private set; }
/// Gets the method name.
public override string MethodName => "delete";
/// Gets the HTTP method.
public override string HttpMethod => "DELETE";
/// Gets the REST path.
public override string RestPath => "v1/{+name}";
/// Initializes Delete parameter list.
protected override void InitParameters()
{
base.InitParameters();
RequestParameters.Add("name", new Google.Apis.Discovery.Parameter
{
Name = "name",
IsRequired = true,
ParameterType = "path",
DefaultValue = null,
Pattern = @"^projects/[^/]+/locations/[^/]+/environments/[^/]+$",
});
}
}
/// Gets details of a single Environment.
///
/// Required. Format: `projects/{project_id}/locations/{location}/environments/{environment_id}`
///
public virtual GetRequest Get(string name)
{
return new GetRequest(this.service, name);
}
/// Gets details of a single Environment.
public class GetRequest : AIPlatformNotebooksBaseServiceRequest
{
/// Constructs a new Get request.
public GetRequest(Google.Apis.Services.IClientService service, string name) : base(service)
{
Name = name;
InitParameters();
}
///
/// Required. Format: `projects/{project_id}/locations/{location}/environments/{environment_id}`
///
[Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)]
public virtual string Name { get; private set; }
/// Gets the method name.
public override string MethodName => "get";
/// Gets the HTTP method.
public override string HttpMethod => "GET";
/// Gets the REST path.
public override string RestPath => "v1/{+name}";
/// Initializes Get parameter list.
protected override void InitParameters()
{
base.InitParameters();
RequestParameters.Add("name", new Google.Apis.Discovery.Parameter
{
Name = "name",
IsRequired = true,
ParameterType = "path",
DefaultValue = null,
Pattern = @"^projects/[^/]+/locations/[^/]+/environments/[^/]+$",
});
}
}
/// Lists environments in a project.
/// Required. Format: `projects/{project_id}/locations/{location}`
public virtual ListRequest List(string parent)
{
return new ListRequest(this.service, parent);
}
/// Lists environments in a project.
public class ListRequest : AIPlatformNotebooksBaseServiceRequest
{
/// Constructs a new List request.
public ListRequest(Google.Apis.Services.IClientService service, string parent) : base(service)
{
Parent = parent;
InitParameters();
}
/// Required. Format: `projects/{project_id}/locations/{location}`
[Google.Apis.Util.RequestParameterAttribute("parent", Google.Apis.Util.RequestParameterType.Path)]
public virtual string Parent { get; private set; }
/// Maximum return size of the list call.
[Google.Apis.Util.RequestParameterAttribute("pageSize", Google.Apis.Util.RequestParameterType.Query)]
public virtual System.Nullable PageSize { get; set; }
///
/// A previous returned page token that can be used to continue listing from the last result.
///
[Google.Apis.Util.RequestParameterAttribute("pageToken", Google.Apis.Util.RequestParameterType.Query)]
public virtual string PageToken { get; set; }
/// Gets the method name.
public override string MethodName => "list";
/// Gets the HTTP method.
public override string HttpMethod => "GET";
/// Gets the REST path.
public override string RestPath => "v1/{+parent}/environments";
/// Initializes List parameter list.
protected override void InitParameters()
{
base.InitParameters();
RequestParameters.Add("parent", new Google.Apis.Discovery.Parameter
{
Name = "parent",
IsRequired = true,
ParameterType = "path",
DefaultValue = null,
Pattern = @"^projects/[^/]+/locations/[^/]+$",
});
RequestParameters.Add("pageSize", new Google.Apis.Discovery.Parameter
{
Name = "pageSize",
IsRequired = false,
ParameterType = "query",
DefaultValue = null,
Pattern = null,
});
RequestParameters.Add("pageToken", new Google.Apis.Discovery.Parameter
{
Name = "pageToken",
IsRequired = false,
ParameterType = "query",
DefaultValue = null,
Pattern = null,
});
}
}
}
/// Gets the Executions resource.
public virtual ExecutionsResource Executions { get; }
/// The "executions" collection of methods.
public class ExecutionsResource
{
private const string Resource = "executions";
/// The service which this resource belongs to.
private readonly Google.Apis.Services.IClientService service;
/// Constructs a new resource.
public ExecutionsResource(Google.Apis.Services.IClientService service)
{
this.service = service;
}
/// Creates a new Execution in a given project and location.
/// The body of the request.
/// Required. Format: `parent=projects/{project_id}/locations/{location}`
public virtual CreateRequest Create(Google.Apis.AIPlatformNotebooks.v1.Data.Execution body, string parent)
{
return new CreateRequest(this.service, body, parent);
}
/// Creates a new Execution in a given project and location.
public class CreateRequest : AIPlatformNotebooksBaseServiceRequest
{
/// Constructs a new Create request.
public CreateRequest(Google.Apis.Services.IClientService service, Google.Apis.AIPlatformNotebooks.v1.Data.Execution body, string parent) : base(service)
{
Parent = parent;
Body = body;
InitParameters();
}
/// Required. Format: `parent=projects/{project_id}/locations/{location}`
[Google.Apis.Util.RequestParameterAttribute("parent", Google.Apis.Util.RequestParameterType.Path)]
public virtual string Parent { get; private set; }
/// Required. User-defined unique ID of this execution.
[Google.Apis.Util.RequestParameterAttribute("executionId", Google.Apis.Util.RequestParameterType.Query)]
public virtual string ExecutionId { get; set; }
/// Gets or sets the body of this request.
Google.Apis.AIPlatformNotebooks.v1.Data.Execution Body { get; set; }
/// Returns the body of the request.
protected override object GetBody() => Body;
/// Gets the method name.
public override string MethodName => "create";
/// Gets the HTTP method.
public override string HttpMethod => "POST";
/// Gets the REST path.
public override string RestPath => "v1/{+parent}/executions";
/// Initializes Create parameter list.
protected override void InitParameters()
{
base.InitParameters();
RequestParameters.Add("parent", new Google.Apis.Discovery.Parameter
{
Name = "parent",
IsRequired = true,
ParameterType = "path",
DefaultValue = null,
Pattern = @"^projects/[^/]+/locations/[^/]+$",
});
RequestParameters.Add("executionId", new Google.Apis.Discovery.Parameter
{
Name = "executionId",
IsRequired = false,
ParameterType = "query",
DefaultValue = null,
Pattern = null,
});
}
}
/// Deletes execution
///
/// Required. Format: `projects/{project_id}/locations/{location}/executions/{execution_id}`
///
public virtual DeleteRequest Delete(string name)
{
return new DeleteRequest(this.service, name);
}
/// Deletes execution
public class DeleteRequest : AIPlatformNotebooksBaseServiceRequest
{
/// Constructs a new Delete request.
public DeleteRequest(Google.Apis.Services.IClientService service, string name) : base(service)
{
Name = name;
InitParameters();
}
///
/// Required. Format: `projects/{project_id}/locations/{location}/executions/{execution_id}`
///
[Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)]
public virtual string Name { get; private set; }
/// Gets the method name.
public override string MethodName => "delete";
/// Gets the HTTP method.
public override string HttpMethod => "DELETE";
/// Gets the REST path.
public override string RestPath => "v1/{+name}";
/// Initializes Delete parameter list.
protected override void InitParameters()
{
base.InitParameters();
RequestParameters.Add("name", new Google.Apis.Discovery.Parameter
{
Name = "name",
IsRequired = true,
ParameterType = "path",
DefaultValue = null,
Pattern = @"^projects/[^/]+/locations/[^/]+/executions/[^/]+$",
});
}
}
/// Gets details of executions
///
/// Required. Format: `projects/{project_id}/locations/{location}/executions/{execution_id}`
///
public virtual GetRequest Get(string name)
{
return new GetRequest(this.service, name);
}
/// Gets details of executions
public class GetRequest : AIPlatformNotebooksBaseServiceRequest
{
/// Constructs a new Get request.
public GetRequest(Google.Apis.Services.IClientService service, string name) : base(service)
{
Name = name;
InitParameters();
}
///
/// Required. Format: `projects/{project_id}/locations/{location}/executions/{execution_id}`
///
[Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)]
public virtual string Name { get; private set; }
/// Gets the method name.
public override string MethodName => "get";
/// Gets the HTTP method.
public override string HttpMethod => "GET";
/// Gets the REST path.
public override string RestPath => "v1/{+name}";
/// Initializes Get parameter list.
protected override void InitParameters()
{
base.InitParameters();
RequestParameters.Add("name", new Google.Apis.Discovery.Parameter
{
Name = "name",
IsRequired = true,
ParameterType = "path",
DefaultValue = null,
Pattern = @"^projects/[^/]+/locations/[^/]+/executions/[^/]+$",
});
}
}
/// Lists executions in a given project and location
/// Required. Format: `parent=projects/{project_id}/locations/{location}`
public virtual ListRequest List(string parent)
{
return new ListRequest(this.service, parent);
}
/// Lists executions in a given project and location
public class ListRequest : AIPlatformNotebooksBaseServiceRequest
{
/// Constructs a new List request.
public ListRequest(Google.Apis.Services.IClientService service, string parent) : base(service)
{
Parent = parent;
InitParameters();
}
/// Required. Format: `parent=projects/{project_id}/locations/{location}`
[Google.Apis.Util.RequestParameterAttribute("parent", Google.Apis.Util.RequestParameterType.Path)]
public virtual string Parent { get; private set; }
///
/// Filter applied to resulting executions. Currently only supports filtering executions by a
/// specified `schedule_id`. Format: `schedule_id=`
///
[Google.Apis.Util.RequestParameterAttribute("filter", Google.Apis.Util.RequestParameterType.Query)]
public virtual string Filter { get; set; }
/// Sort by field.
[Google.Apis.Util.RequestParameterAttribute("orderBy", Google.Apis.Util.RequestParameterType.Query)]
public virtual string OrderBy { get; set; }
/// Maximum return size of the list call.
[Google.Apis.Util.RequestParameterAttribute("pageSize", Google.Apis.Util.RequestParameterType.Query)]
public virtual System.Nullable PageSize { get; set; }
///
/// A previous returned page token that can be used to continue listing from the last result.
///
[Google.Apis.Util.RequestParameterAttribute("pageToken", Google.Apis.Util.RequestParameterType.Query)]
public virtual string PageToken { get; set; }
/// Gets the method name.
public override string MethodName => "list";
/// Gets the HTTP method.
public override string HttpMethod => "GET";
/// Gets the REST path.
public override string RestPath => "v1/{+parent}/executions";
/// Initializes List parameter list.
protected override void InitParameters()
{
base.InitParameters();
RequestParameters.Add("parent", new Google.Apis.Discovery.Parameter
{
Name = "parent",
IsRequired = true,
ParameterType = "path",
DefaultValue = null,
Pattern = @"^projects/[^/]+/locations/[^/]+$",
});
RequestParameters.Add("filter", new Google.Apis.Discovery.Parameter
{
Name = "filter",
IsRequired = false,
ParameterType = "query",
DefaultValue = null,
Pattern = null,
});
RequestParameters.Add("orderBy", new Google.Apis.Discovery.Parameter
{
Name = "orderBy",
IsRequired = false,
ParameterType = "query",
DefaultValue = null,
Pattern = null,
});
RequestParameters.Add("pageSize", new Google.Apis.Discovery.Parameter
{
Name = "pageSize",
IsRequired = false,
ParameterType = "query",
DefaultValue = null,
Pattern = null,
});
RequestParameters.Add("pageToken", new Google.Apis.Discovery.Parameter
{
Name = "pageToken",
IsRequired = false,
ParameterType = "query",
DefaultValue = null,
Pattern = null,
});
}
}
}
/// Gets the Instances resource.
public virtual InstancesResource Instances { get; }
/// The "instances" collection of methods.
public class InstancesResource
{
private const string Resource = "instances";
/// The service which this resource belongs to.
private readonly Google.Apis.Services.IClientService service;
/// Constructs a new resource.
public InstancesResource(Google.Apis.Services.IClientService service)
{
this.service = service;
}
/// Creates a new Instance in a given project and location.
/// The body of the request.
/// Required. Format: `parent=projects/{project_id}/locations/{location}`
public virtual CreateRequest Create(Google.Apis.AIPlatformNotebooks.v1.Data.Instance body, string parent)
{
return new CreateRequest(this.service, body, parent);
}
/// Creates a new Instance in a given project and location.
public class CreateRequest : AIPlatformNotebooksBaseServiceRequest
{
/// Constructs a new Create request.
public CreateRequest(Google.Apis.Services.IClientService service, Google.Apis.AIPlatformNotebooks.v1.Data.Instance body, string parent) : base(service)
{
Parent = parent;
Body = body;
InitParameters();
}
/// Required. Format: `parent=projects/{project_id}/locations/{location}`
[Google.Apis.Util.RequestParameterAttribute("parent", Google.Apis.Util.RequestParameterType.Path)]
public virtual string Parent { get; private set; }
/// Required. User-defined unique ID of this instance.
[Google.Apis.Util.RequestParameterAttribute("instanceId", Google.Apis.Util.RequestParameterType.Query)]
public virtual string InstanceId { get; set; }
/// Gets or sets the body of this request.
Google.Apis.AIPlatformNotebooks.v1.Data.Instance Body { get; set; }
/// Returns the body of the request.
protected override object GetBody() => Body;
/// Gets the method name.
public override string MethodName => "create";
/// Gets the HTTP method.
public override string HttpMethod => "POST";
/// Gets the REST path.
public override string RestPath => "v1/{+parent}/instances";
/// Initializes Create parameter list.
protected override void InitParameters()
{
base.InitParameters();
RequestParameters.Add("parent", new Google.Apis.Discovery.Parameter
{
Name = "parent",
IsRequired = true,
ParameterType = "path",
DefaultValue = null,
Pattern = @"^projects/[^/]+/locations/[^/]+$",
});
RequestParameters.Add("instanceId", new Google.Apis.Discovery.Parameter
{
Name = "instanceId",
IsRequired = false,
ParameterType = "query",
DefaultValue = null,
Pattern = null,
});
}
}
/// Deletes a single Instance.
///
/// Required. Format: `projects/{project_id}/locations/{location}/instances/{instance_id}`
///
public virtual DeleteRequest Delete(string name)
{
return new DeleteRequest(this.service, name);
}
/// Deletes a single Instance.
public class DeleteRequest : AIPlatformNotebooksBaseServiceRequest
{
/// Constructs a new Delete request.
public DeleteRequest(Google.Apis.Services.IClientService service, string name) : base(service)
{
Name = name;
InitParameters();
}
///
/// Required. Format: `projects/{project_id}/locations/{location}/instances/{instance_id}`
///
[Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)]
public virtual string Name { get; private set; }
/// Gets the method name.
public override string MethodName => "delete";
/// Gets the HTTP method.
public override string HttpMethod => "DELETE";
/// Gets the REST path.
public override string RestPath => "v1/{+name}";
/// Initializes Delete parameter list.
protected override void InitParameters()
{
base.InitParameters();
RequestParameters.Add("name", new Google.Apis.Discovery.Parameter
{
Name = "name",
IsRequired = true,
ParameterType = "path",
DefaultValue = null,
Pattern = @"^projects/[^/]+/locations/[^/]+/instances/[^/]+$",
});
}
}
/// Creates a Diagnostic File and runs Diagnostic Tool given an Instance.
/// The body of the request.
///
/// Required. Format: `projects/{project_id}/locations/{location}/instances/{instance_id}`
///
public virtual DiagnoseRequest Diagnose(Google.Apis.AIPlatformNotebooks.v1.Data.DiagnoseInstanceRequest body, string name)
{
return new DiagnoseRequest(this.service, body, name);
}
/// Creates a Diagnostic File and runs Diagnostic Tool given an Instance.
public class DiagnoseRequest : AIPlatformNotebooksBaseServiceRequest
{
/// Constructs a new Diagnose request.
public DiagnoseRequest(Google.Apis.Services.IClientService service, Google.Apis.AIPlatformNotebooks.v1.Data.DiagnoseInstanceRequest body, string name) : base(service)
{
Name = name;
Body = body;
InitParameters();
}
///
/// Required. Format: `projects/{project_id}/locations/{location}/instances/{instance_id}`
///
[Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)]
public virtual string Name { get; private set; }
/// Gets or sets the body of this request.
Google.Apis.AIPlatformNotebooks.v1.Data.DiagnoseInstanceRequest Body { get; set; }
/// Returns the body of the request.
protected override object GetBody() => Body;
/// Gets the method name.
public override string MethodName => "diagnose";
/// Gets the HTTP method.
public override string HttpMethod => "POST";
/// Gets the REST path.
public override string RestPath => "v1/{+name}:diagnose";
/// Initializes Diagnose parameter list.
protected override void InitParameters()
{
base.InitParameters();
RequestParameters.Add("name", new Google.Apis.Discovery.Parameter
{
Name = "name",
IsRequired = true,
ParameterType = "path",
DefaultValue = null,
Pattern = @"^projects/[^/]+/locations/[^/]+/instances/[^/]+$",
});
}
}
/// Gets details of a single Instance.
///
/// Required. Format: `projects/{project_id}/locations/{location}/instances/{instance_id}`
///
public virtual GetRequest Get(string name)
{
return new GetRequest(this.service, name);
}
/// Gets details of a single Instance.
public class GetRequest : AIPlatformNotebooksBaseServiceRequest
{
/// Constructs a new Get request.
public GetRequest(Google.Apis.Services.IClientService service, string name) : base(service)
{
Name = name;
InitParameters();
}
///
/// Required. Format: `projects/{project_id}/locations/{location}/instances/{instance_id}`
///
[Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)]
public virtual string Name { get; private set; }
/// Gets the method name.
public override string MethodName => "get";
/// Gets the HTTP method.
public override string HttpMethod => "GET";
/// Gets the REST path.
public override string RestPath => "v1/{+name}";
/// Initializes Get parameter list.
protected override void InitParameters()
{
base.InitParameters();
RequestParameters.Add("name", new Google.Apis.Discovery.Parameter
{
Name = "name",
IsRequired = true,
ParameterType = "path",
DefaultValue = null,
Pattern = @"^projects/[^/]+/locations/[^/]+/instances/[^/]+$",
});
}
}
///
/// Gets the access control policy for a resource. Returns an empty policy if the resource exists and
/// does not have a policy set.
///
///
/// REQUIRED: The resource for which the policy is being requested. See [Resource
/// names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this
/// field.
///
public virtual GetIamPolicyRequest GetIamPolicy(string resource)
{
return new GetIamPolicyRequest(this.service, resource);
}
///
/// Gets the access control policy for a resource. Returns an empty policy if the resource exists and
/// does not have a policy set.
///
public class GetIamPolicyRequest : AIPlatformNotebooksBaseServiceRequest
{
/// Constructs a new GetIamPolicy request.
public GetIamPolicyRequest(Google.Apis.Services.IClientService service, string resource) : base(service)
{
Resource = resource;
InitParameters();
}
///
/// REQUIRED: The resource for which the policy is being requested. See [Resource
/// names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this
/// field.
///
[Google.Apis.Util.RequestParameterAttribute("resource", Google.Apis.Util.RequestParameterType.Path)]
public virtual string Resource { get; private set; }
///
/// 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](https://cloud.google.com/iam/help/conditions/resource-policies).
///
[Google.Apis.Util.RequestParameterAttribute("options.requestedPolicyVersion", Google.Apis.Util.RequestParameterType.Query)]
public virtual System.Nullable OptionsRequestedPolicyVersion { get; set; }
/// Gets the method name.
public override string MethodName => "getIamPolicy";
/// Gets the HTTP method.
public override string HttpMethod => "GET";
/// Gets the REST path.
public override string RestPath => "v1/{+resource}:getIamPolicy";
/// Initializes GetIamPolicy parameter list.
protected override void InitParameters()
{
base.InitParameters();
RequestParameters.Add("resource", new Google.Apis.Discovery.Parameter
{
Name = "resource",
IsRequired = true,
ParameterType = "path",
DefaultValue = null,
Pattern = @"^projects/[^/]+/locations/[^/]+/instances/[^/]+$",
});
RequestParameters.Add("options.requestedPolicyVersion", new Google.Apis.Discovery.Parameter
{
Name = "options.requestedPolicyVersion",
IsRequired = false,
ParameterType = "query",
DefaultValue = null,
Pattern = null,
});
}
}
/// Checks whether a notebook instance is healthy.
///
/// Required. Format: `projects/{project_id}/locations/{location}/instances/{instance_id}`
///
public virtual GetInstanceHealthRequest GetInstanceHealth(string name)
{
return new GetInstanceHealthRequest(this.service, name);
}
/// Checks whether a notebook instance is healthy.
public class GetInstanceHealthRequest : AIPlatformNotebooksBaseServiceRequest
{
/// Constructs a new GetInstanceHealth request.
public GetInstanceHealthRequest(Google.Apis.Services.IClientService service, string name) : base(service)
{
Name = name;
InitParameters();
}
///
/// Required. Format: `projects/{project_id}/locations/{location}/instances/{instance_id}`
///
[Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)]
public virtual string Name { get; private set; }
/// Gets the method name.
public override string MethodName => "getInstanceHealth";
/// Gets the HTTP method.
public override string HttpMethod => "GET";
/// Gets the REST path.
public override string RestPath => "v1/{+name}:getInstanceHealth";
/// Initializes GetInstanceHealth parameter list.
protected override void InitParameters()
{
base.InitParameters();
RequestParameters.Add("name", new Google.Apis.Discovery.Parameter
{
Name = "name",
IsRequired = true,
ParameterType = "path",
DefaultValue = null,
Pattern = @"^projects/[^/]+/locations/[^/]+/instances/[^/]+$",
});
}
}
/// Checks whether a notebook instance is upgradable.
///
/// Required. Format: `projects/{project_id}/locations/{location}/instances/{instance_id}`
///
public virtual IsUpgradeableRequest IsUpgradeable(string notebookInstance)
{
return new IsUpgradeableRequest(this.service, notebookInstance);
}
/// Checks whether a notebook instance is upgradable.
public class IsUpgradeableRequest : AIPlatformNotebooksBaseServiceRequest
{
/// Constructs a new IsUpgradeable request.
public IsUpgradeableRequest(Google.Apis.Services.IClientService service, string notebookInstance) : base(service)
{
NotebookInstance = notebookInstance;
InitParameters();
}
///
/// Required. Format: `projects/{project_id}/locations/{location}/instances/{instance_id}`
///
[Google.Apis.Util.RequestParameterAttribute("notebookInstance", Google.Apis.Util.RequestParameterType.Path)]
public virtual string NotebookInstance { get; private set; }
///
/// Optional. The optional UpgradeType. Setting this field will search for additional compute images
/// to upgrade this instance.
///
[Google.Apis.Util.RequestParameterAttribute("type", Google.Apis.Util.RequestParameterType.Query)]
public virtual System.Nullable Type { get; set; }
///
/// Optional. The optional UpgradeType. Setting this field will search for additional compute images
/// to upgrade this instance.
///
public enum TypeEnum
{
/// Upgrade type is not specified.
[Google.Apis.Util.StringValueAttribute("UPGRADE_TYPE_UNSPECIFIED")]
UPGRADETYPEUNSPECIFIED = 0,
/// Upgrade ML framework.
[Google.Apis.Util.StringValueAttribute("UPGRADE_FRAMEWORK")]
UPGRADEFRAMEWORK = 1,
/// Upgrade Operating System.
[Google.Apis.Util.StringValueAttribute("UPGRADE_OS")]
UPGRADEOS = 2,
/// Upgrade CUDA.
[Google.Apis.Util.StringValueAttribute("UPGRADE_CUDA")]
UPGRADECUDA = 3,
/// Upgrade All (OS, Framework and CUDA).
[Google.Apis.Util.StringValueAttribute("UPGRADE_ALL")]
UPGRADEALL = 4,
}
/// Gets the method name.
public override string MethodName => "isUpgradeable";
/// Gets the HTTP method.
public override string HttpMethod => "GET";
/// Gets the REST path.
public override string RestPath => "v1/{+notebookInstance}:isUpgradeable";
/// Initializes IsUpgradeable parameter list.
protected override void InitParameters()
{
base.InitParameters();
RequestParameters.Add("notebookInstance", new Google.Apis.Discovery.Parameter
{
Name = "notebookInstance",
IsRequired = true,
ParameterType = "path",
DefaultValue = null,
Pattern = @"^projects/[^/]+/locations/[^/]+/instances/[^/]+$",
});
RequestParameters.Add("type", new Google.Apis.Discovery.Parameter
{
Name = "type",
IsRequired = false,
ParameterType = "query",
DefaultValue = null,
Pattern = null,
});
}
}
/// Lists instances in a given project and location.
/// Required. Format: `parent=projects/{project_id}/locations/{location}`
public virtual ListRequest List(string parent)
{
return new ListRequest(this.service, parent);
}
/// Lists instances in a given project and location.
public class ListRequest : AIPlatformNotebooksBaseServiceRequest
{
/// Constructs a new List request.
public ListRequest(Google.Apis.Services.IClientService service, string parent) : base(service)
{
Parent = parent;
InitParameters();
}
/// Required. Format: `parent=projects/{project_id}/locations/{location}`
[Google.Apis.Util.RequestParameterAttribute("parent", Google.Apis.Util.RequestParameterType.Path)]
public virtual string Parent { get; private set; }
/// Optional. List filter.
[Google.Apis.Util.RequestParameterAttribute("filter", Google.Apis.Util.RequestParameterType.Query)]
public virtual string Filter { get; set; }
///
/// Optional. Sort results. Supported values are "name", "name desc" or "" (unsorted).
///
[Google.Apis.Util.RequestParameterAttribute("orderBy", Google.Apis.Util.RequestParameterType.Query)]
public virtual string OrderBy { get; set; }
/// Maximum return size of the list call.
[Google.Apis.Util.RequestParameterAttribute("pageSize", Google.Apis.Util.RequestParameterType.Query)]
public virtual System.Nullable PageSize { get; set; }
///
/// A previous returned page token that can be used to continue listing from the last result.
///
[Google.Apis.Util.RequestParameterAttribute("pageToken", Google.Apis.Util.RequestParameterType.Query)]
public virtual string PageToken { get; set; }
/// Gets the method name.
public override string MethodName => "list";
/// Gets the HTTP method.
public override string HttpMethod => "GET";
/// Gets the REST path.
public override string RestPath => "v1/{+parent}/instances";
/// Initializes List parameter list.
protected override void InitParameters()
{
base.InitParameters();
RequestParameters.Add("parent", new Google.Apis.Discovery.Parameter
{
Name = "parent",
IsRequired = true,
ParameterType = "path",
DefaultValue = null,
Pattern = @"^projects/[^/]+/locations/[^/]+$",
});
RequestParameters.Add("filter", new Google.Apis.Discovery.Parameter
{
Name = "filter",
IsRequired = false,
ParameterType = "query",
DefaultValue = null,
Pattern = null,
});
RequestParameters.Add("orderBy", new Google.Apis.Discovery.Parameter
{
Name = "orderBy",
IsRequired = false,
ParameterType = "query",
DefaultValue = null,
Pattern = null,
});
RequestParameters.Add("pageSize", new Google.Apis.Discovery.Parameter
{
Name = "pageSize",
IsRequired = false,
ParameterType = "query",
DefaultValue = null,
Pattern = null,
});
RequestParameters.Add("pageToken", new Google.Apis.Discovery.Parameter
{
Name = "pageToken",
IsRequired = false,
ParameterType = "query",
DefaultValue = null,
Pattern = null,
});
}
}
/// Migrates an existing User-Managed Notebook to Workbench Instances.
/// The body of the request.
///
/// Required. Format: `projects/{project_id}/locations/{location}/instances/{instance_id}`
///
public virtual MigrateRequest Migrate(Google.Apis.AIPlatformNotebooks.v1.Data.MigrateInstanceRequest body, string name)
{
return new MigrateRequest(this.service, body, name);
}
/// Migrates an existing User-Managed Notebook to Workbench Instances.
public class MigrateRequest : AIPlatformNotebooksBaseServiceRequest
{
/// Constructs a new Migrate request.
public MigrateRequest(Google.Apis.Services.IClientService service, Google.Apis.AIPlatformNotebooks.v1.Data.MigrateInstanceRequest body, string name) : base(service)
{
Name = name;
Body = body;
InitParameters();
}
///
/// Required. Format: `projects/{project_id}/locations/{location}/instances/{instance_id}`
///
[Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)]
public virtual string Name { get; private set; }
/// Gets or sets the body of this request.
Google.Apis.AIPlatformNotebooks.v1.Data.MigrateInstanceRequest Body { get; set; }
/// Returns the body of the request.
protected override object GetBody() => Body;
/// Gets the method name.
public override string MethodName => "migrate";
/// Gets the HTTP method.
public override string HttpMethod => "POST";
/// Gets the REST path.
public override string RestPath => "v1/{+name}:migrate";
/// Initializes Migrate parameter list.
protected override void InitParameters()
{
base.InitParameters();
RequestParameters.Add("name", new Google.Apis.Discovery.Parameter
{
Name = "name",
IsRequired = true,
ParameterType = "path",
DefaultValue = null,
Pattern = @"^projects/[^/]+/locations/[^/]+/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.
///
/// The body of the request.
/// Required. Format: `parent=projects/{project_id}/locations/{location}`
public virtual RegisterRequest Register(Google.Apis.AIPlatformNotebooks.v1.Data.RegisterInstanceRequest body, string parent)
{
return new RegisterRequest(this.service, body, parent);
}
///
/// 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.
///
public class RegisterRequest : AIPlatformNotebooksBaseServiceRequest
{
/// Constructs a new Register request.
public RegisterRequest(Google.Apis.Services.IClientService service, Google.Apis.AIPlatformNotebooks.v1.Data.RegisterInstanceRequest body, string parent) : base(service)
{
Parent = parent;
Body = body;
InitParameters();
}
/// Required. Format: `parent=projects/{project_id}/locations/{location}`
[Google.Apis.Util.RequestParameterAttribute("parent", Google.Apis.Util.RequestParameterType.Path)]
public virtual string Parent { get; private set; }
/// Gets or sets the body of this request.
Google.Apis.AIPlatformNotebooks.v1.Data.RegisterInstanceRequest Body { get; set; }
/// Returns the body of the request.
protected override object GetBody() => Body;
/// Gets the method name.
public override string MethodName => "register";
/// Gets the HTTP method.
public override string HttpMethod => "POST";
/// Gets the REST path.
public override string RestPath => "v1/{+parent}/instances:register";
/// Initializes Register parameter list.
protected override void InitParameters()
{
base.InitParameters();
RequestParameters.Add("parent", new Google.Apis.Discovery.Parameter
{
Name = "parent",
IsRequired = true,
ParameterType = "path",
DefaultValue = null,
Pattern = @"^projects/[^/]+/locations/[^/]+$",
});
}
}
///
/// 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.
///
/// The body of the request.
///
/// Required. Format: `projects/{project_id}/locations/{location}/instances/{instance_id}`
///
public virtual ReportRequest Report(Google.Apis.AIPlatformNotebooks.v1.Data.ReportInstanceInfoRequest body, string name)
{
return new ReportRequest(this.service, body, name);
}
///
/// 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.
///
public class ReportRequest : AIPlatformNotebooksBaseServiceRequest
{
/// Constructs a new Report request.
public ReportRequest(Google.Apis.Services.IClientService service, Google.Apis.AIPlatformNotebooks.v1.Data.ReportInstanceInfoRequest body, string name) : base(service)
{
Name = name;
Body = body;
InitParameters();
}
///
/// Required. Format: `projects/{project_id}/locations/{location}/instances/{instance_id}`
///
[Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)]
public virtual string Name { get; private set; }
/// Gets or sets the body of this request.
Google.Apis.AIPlatformNotebooks.v1.Data.ReportInstanceInfoRequest Body { get; set; }
/// Returns the body of the request.
protected override object GetBody() => Body;
/// Gets the method name.
public override string MethodName => "report";
/// Gets the HTTP method.
public override string HttpMethod => "POST";
/// Gets the REST path.
public override string RestPath => "v1/{+name}:report";
/// Initializes Report parameter list.
protected override void InitParameters()
{
base.InitParameters();
RequestParameters.Add("name", new Google.Apis.Discovery.Parameter
{
Name = "name",
IsRequired = true,
ParameterType = "path",
DefaultValue = null,
Pattern = @"^projects/[^/]+/locations/[^/]+/instances/[^/]+$",
});
}
}
/// Reports and processes an instance event.
/// The body of the request.
///
/// Required. Format: `projects/{project_id}/locations/{location}/instances/{instance_id}`
///
public virtual ReportEventRequest ReportEvent(Google.Apis.AIPlatformNotebooks.v1.Data.ReportInstanceEventRequest body, string name)
{
return new ReportEventRequest(this.service, body, name);
}
/// Reports and processes an instance event.
public class ReportEventRequest : AIPlatformNotebooksBaseServiceRequest
{
/// Constructs a new ReportEvent request.
public ReportEventRequest(Google.Apis.Services.IClientService service, Google.Apis.AIPlatformNotebooks.v1.Data.ReportInstanceEventRequest body, string name) : base(service)
{
Name = name;
Body = body;
InitParameters();
}
///
/// Required. Format: `projects/{project_id}/locations/{location}/instances/{instance_id}`
///
[Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)]
public virtual string Name { get; private set; }
/// Gets or sets the body of this request.
Google.Apis.AIPlatformNotebooks.v1.Data.ReportInstanceEventRequest Body { get; set; }
/// Returns the body of the request.
protected override object GetBody() => Body;
/// Gets the method name.
public override string MethodName => "reportEvent";
/// Gets the HTTP method.
public override string HttpMethod => "POST";
/// Gets the REST path.
public override string RestPath => "v1/{+name}:reportEvent";
/// Initializes ReportEvent parameter list.
protected override void InitParameters()
{
base.InitParameters();
RequestParameters.Add("name", new Google.Apis.Discovery.Parameter
{
Name = "name",
IsRequired = true,
ParameterType = "path",
DefaultValue = null,
Pattern = @"^projects/[^/]+/locations/[^/]+/instances/[^/]+$",
});
}
}
/// Resets a notebook instance.
/// The body of the request.
///
/// Required. Format: `projects/{project_id}/locations/{location}/instances/{instance_id}`
///
public virtual ResetRequest Reset(Google.Apis.AIPlatformNotebooks.v1.Data.ResetInstanceRequest body, string name)
{
return new ResetRequest(this.service, body, name);
}
/// Resets a notebook instance.
public class ResetRequest : AIPlatformNotebooksBaseServiceRequest
{
/// Constructs a new Reset request.
public ResetRequest(Google.Apis.Services.IClientService service, Google.Apis.AIPlatformNotebooks.v1.Data.ResetInstanceRequest body, string name) : base(service)
{
Name = name;
Body = body;
InitParameters();
}
///
/// Required. Format: `projects/{project_id}/locations/{location}/instances/{instance_id}`
///
[Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)]
public virtual string Name { get; private set; }
/// Gets or sets the body of this request.
Google.Apis.AIPlatformNotebooks.v1.Data.ResetInstanceRequest Body { get; set; }
/// Returns the body of the request.
protected override object GetBody() => Body;
/// Gets the method name.
public override string MethodName => "reset";
/// Gets the HTTP method.
public override string HttpMethod => "POST";
/// Gets the REST path.
public override string RestPath => "v1/{+name}:reset";
/// Initializes Reset parameter list.
protected override void InitParameters()
{
base.InitParameters();
RequestParameters.Add("name", new Google.Apis.Discovery.Parameter
{
Name = "name",
IsRequired = true,
ParameterType = "path",
DefaultValue = null,
Pattern = @"^projects/[^/]+/locations/[^/]+/instances/[^/]+$",
});
}
}
/// Rollbacks a notebook instance to the previous version.
/// The body of the request.
///
/// Required. Format: `projects/{project_id}/locations/{location}/instances/{instance_id}`
///
public virtual RollbackRequest Rollback(Google.Apis.AIPlatformNotebooks.v1.Data.RollbackInstanceRequest body, string name)
{
return new RollbackRequest(this.service, body, name);
}
/// Rollbacks a notebook instance to the previous version.
public class RollbackRequest : AIPlatformNotebooksBaseServiceRequest
{
/// Constructs a new Rollback request.
public RollbackRequest(Google.Apis.Services.IClientService service, Google.Apis.AIPlatformNotebooks.v1.Data.RollbackInstanceRequest body, string name) : base(service)
{
Name = name;
Body = body;
InitParameters();
}
///
/// Required. Format: `projects/{project_id}/locations/{location}/instances/{instance_id}`
///
[Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)]
public virtual string Name { get; private set; }
/// Gets or sets the body of this request.
Google.Apis.AIPlatformNotebooks.v1.Data.RollbackInstanceRequest Body { get; set; }
/// Returns the body of the request.
protected override object GetBody() => Body;
/// Gets the method name.
public override string MethodName => "rollback";
/// Gets the HTTP method.
public override string HttpMethod => "POST";
/// Gets the REST path.
public override string RestPath => "v1/{+name}:rollback";
/// Initializes Rollback parameter list.
protected override void InitParameters()
{
base.InitParameters();
RequestParameters.Add("name", new Google.Apis.Discovery.Parameter
{
Name = "name",
IsRequired = true,
ParameterType = "path",
DefaultValue = null,
Pattern = @"^projects/[^/]+/locations/[^/]+/instances/[^/]+$",
});
}
}
/// Updates the guest accelerators of a single Instance.
/// The body of the request.
///
/// Required. Format: `projects/{project_id}/locations/{location}/instances/{instance_id}`
///
public virtual SetAcceleratorRequest SetAccelerator(Google.Apis.AIPlatformNotebooks.v1.Data.SetInstanceAcceleratorRequest body, string name)
{
return new SetAcceleratorRequest(this.service, body, name);
}
/// Updates the guest accelerators of a single Instance.
public class SetAcceleratorRequest : AIPlatformNotebooksBaseServiceRequest
{
/// Constructs a new SetAccelerator request.
public SetAcceleratorRequest(Google.Apis.Services.IClientService service, Google.Apis.AIPlatformNotebooks.v1.Data.SetInstanceAcceleratorRequest body, string name) : base(service)
{
Name = name;
Body = body;
InitParameters();
}
///
/// Required. Format: `projects/{project_id}/locations/{location}/instances/{instance_id}`
///
[Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)]
public virtual string Name { get; private set; }
/// Gets or sets the body of this request.
Google.Apis.AIPlatformNotebooks.v1.Data.SetInstanceAcceleratorRequest Body { get; set; }
/// Returns the body of the request.
protected override object GetBody() => Body;
/// Gets the method name.
public override string MethodName => "setAccelerator";
/// Gets the HTTP method.
public override string HttpMethod => "PATCH";
/// Gets the REST path.
public override string RestPath => "v1/{+name}:setAccelerator";
/// Initializes SetAccelerator parameter list.
protected override void InitParameters()
{
base.InitParameters();
RequestParameters.Add("name", new Google.Apis.Discovery.Parameter
{
Name = "name",
IsRequired = true,
ParameterType = "path",
DefaultValue = null,
Pattern = @"^projects/[^/]+/locations/[^/]+/instances/[^/]+$",
});
}
}
///
/// Sets the access control policy on the specified resource. Replaces any existing policy. Can return
/// `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.
///
/// The body of the request.
///
/// REQUIRED: The resource for which the policy is being specified. See [Resource
/// names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this
/// field.
///
public virtual SetIamPolicyRequest SetIamPolicy(Google.Apis.AIPlatformNotebooks.v1.Data.SetIamPolicyRequest body, string resource)
{
return new SetIamPolicyRequest(this.service, body, resource);
}
///
/// Sets the access control policy on the specified resource. Replaces any existing policy. Can return
/// `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.
///
public class SetIamPolicyRequest : AIPlatformNotebooksBaseServiceRequest
{
/// Constructs a new SetIamPolicy request.
public SetIamPolicyRequest(Google.Apis.Services.IClientService service, Google.Apis.AIPlatformNotebooks.v1.Data.SetIamPolicyRequest body, string resource) : base(service)
{
Resource = resource;
Body = body;
InitParameters();
}
///
/// REQUIRED: The resource for which the policy is being specified. See [Resource
/// names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this
/// field.
///
[Google.Apis.Util.RequestParameterAttribute("resource", Google.Apis.Util.RequestParameterType.Path)]
public virtual string Resource { get; private set; }
/// Gets or sets the body of this request.
Google.Apis.AIPlatformNotebooks.v1.Data.SetIamPolicyRequest Body { get; set; }
/// Returns the body of the request.
protected override object GetBody() => Body;
/// Gets the method name.
public override string MethodName => "setIamPolicy";
/// Gets the HTTP method.
public override string HttpMethod => "POST";
/// Gets the REST path.
public override string RestPath => "v1/{+resource}:setIamPolicy";
/// Initializes SetIamPolicy parameter list.
protected override void InitParameters()
{
base.InitParameters();
RequestParameters.Add("resource", new Google.Apis.Discovery.Parameter
{
Name = "resource",
IsRequired = true,
ParameterType = "path",
DefaultValue = null,
Pattern = @"^projects/[^/]+/locations/[^/]+/instances/[^/]+$",
});
}
}
/// Replaces all the labels of an Instance.
/// The body of the request.
///
/// Required. Format: `projects/{project_id}/locations/{location}/instances/{instance_id}`
///
public virtual SetLabelsRequest SetLabels(Google.Apis.AIPlatformNotebooks.v1.Data.SetInstanceLabelsRequest body, string name)
{
return new SetLabelsRequest(this.service, body, name);
}
/// Replaces all the labels of an Instance.
public class SetLabelsRequest : AIPlatformNotebooksBaseServiceRequest
{
/// Constructs a new SetLabels request.
public SetLabelsRequest(Google.Apis.Services.IClientService service, Google.Apis.AIPlatformNotebooks.v1.Data.SetInstanceLabelsRequest body, string name) : base(service)
{
Name = name;
Body = body;
InitParameters();
}
///
/// Required. Format: `projects/{project_id}/locations/{location}/instances/{instance_id}`
///
[Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)]
public virtual string Name { get; private set; }
/// Gets or sets the body of this request.
Google.Apis.AIPlatformNotebooks.v1.Data.SetInstanceLabelsRequest Body { get; set; }
/// Returns the body of the request.
protected override object GetBody() => Body;
/// Gets the method name.
public override string MethodName => "setLabels";
/// Gets the HTTP method.
public override string HttpMethod => "PATCH";
/// Gets the REST path.
public override string RestPath => "v1/{+name}:setLabels";
/// Initializes SetLabels parameter list.
protected override void InitParameters()
{
base.InitParameters();
RequestParameters.Add("name", new Google.Apis.Discovery.Parameter
{
Name = "name",
IsRequired = true,
ParameterType = "path",
DefaultValue = null,
Pattern = @"^projects/[^/]+/locations/[^/]+/instances/[^/]+$",
});
}
}
/// Updates the machine type of a single Instance.
/// The body of the request.
///
/// Required. Format: `projects/{project_id}/locations/{location}/instances/{instance_id}`
///
public virtual SetMachineTypeRequest SetMachineType(Google.Apis.AIPlatformNotebooks.v1.Data.SetInstanceMachineTypeRequest body, string name)
{
return new SetMachineTypeRequest(this.service, body, name);
}
/// Updates the machine type of a single Instance.
public class SetMachineTypeRequest : AIPlatformNotebooksBaseServiceRequest
{
/// Constructs a new SetMachineType request.
public SetMachineTypeRequest(Google.Apis.Services.IClientService service, Google.Apis.AIPlatformNotebooks.v1.Data.SetInstanceMachineTypeRequest body, string name) : base(service)
{
Name = name;
Body = body;
InitParameters();
}
///
/// Required. Format: `projects/{project_id}/locations/{location}/instances/{instance_id}`
///
[Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)]
public virtual string Name { get; private set; }
/// Gets or sets the body of this request.
Google.Apis.AIPlatformNotebooks.v1.Data.SetInstanceMachineTypeRequest Body { get; set; }
/// Returns the body of the request.
protected override object GetBody() => Body;
/// Gets the method name.
public override string MethodName => "setMachineType";
/// Gets the HTTP method.
public override string HttpMethod => "PATCH";
/// Gets the REST path.
public override string RestPath => "v1/{+name}:setMachineType";
/// Initializes SetMachineType parameter list.
protected override void InitParameters()
{
base.InitParameters();
RequestParameters.Add("name", new Google.Apis.Discovery.Parameter
{
Name = "name",
IsRequired = true,
ParameterType = "path",
DefaultValue = null,
Pattern = @"^projects/[^/]+/locations/[^/]+/instances/[^/]+$",
});
}
}
/// Starts a notebook instance.
/// The body of the request.
///
/// Required. Format: `projects/{project_id}/locations/{location}/instances/{instance_id}`
///
public virtual StartRequest Start(Google.Apis.AIPlatformNotebooks.v1.Data.StartInstanceRequest body, string name)
{
return new StartRequest(this.service, body, name);
}
/// Starts a notebook instance.
public class StartRequest : AIPlatformNotebooksBaseServiceRequest
{
/// Constructs a new Start request.
public StartRequest(Google.Apis.Services.IClientService service, Google.Apis.AIPlatformNotebooks.v1.Data.StartInstanceRequest body, string name) : base(service)
{
Name = name;
Body = body;
InitParameters();
}
///
/// Required. Format: `projects/{project_id}/locations/{location}/instances/{instance_id}`
///
[Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)]
public virtual string Name { get; private set; }
/// Gets or sets the body of this request.
Google.Apis.AIPlatformNotebooks.v1.Data.StartInstanceRequest Body { get; set; }
/// Returns the body of the request.
protected override object GetBody() => Body;
/// Gets the method name.
public override string MethodName => "start";
/// Gets the HTTP method.
public override string HttpMethod => "POST";
/// Gets the REST path.
public override string RestPath => "v1/{+name}:start";
/// Initializes Start parameter list.
protected override void InitParameters()
{
base.InitParameters();
RequestParameters.Add("name", new Google.Apis.Discovery.Parameter
{
Name = "name",
IsRequired = true,
ParameterType = "path",
DefaultValue = null,
Pattern = @"^projects/[^/]+/locations/[^/]+/instances/[^/]+$",
});
}
}
/// Stops a notebook instance.
/// The body of the request.
///
/// Required. Format: `projects/{project_id}/locations/{location}/instances/{instance_id}`
///
public virtual StopRequest Stop(Google.Apis.AIPlatformNotebooks.v1.Data.StopInstanceRequest body, string name)
{
return new StopRequest(this.service, body, name);
}
/// Stops a notebook instance.
public class StopRequest : AIPlatformNotebooksBaseServiceRequest
{
/// Constructs a new Stop request.
public StopRequest(Google.Apis.Services.IClientService service, Google.Apis.AIPlatformNotebooks.v1.Data.StopInstanceRequest body, string name) : base(service)
{
Name = name;
Body = body;
InitParameters();
}
///
/// Required. Format: `projects/{project_id}/locations/{location}/instances/{instance_id}`
///
[Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)]
public virtual string Name { get; private set; }
/// Gets or sets the body of this request.
Google.Apis.AIPlatformNotebooks.v1.Data.StopInstanceRequest Body { get; set; }
/// Returns the body of the request.
protected override object GetBody() => Body;
/// Gets the method name.
public override string MethodName => "stop";
/// Gets the HTTP method.
public override string HttpMethod => "POST";
/// Gets the REST path.
public override string RestPath => "v1/{+name}:stop";
/// Initializes Stop parameter list.
protected override void InitParameters()
{
base.InitParameters();
RequestParameters.Add("name", new Google.Apis.Discovery.Parameter
{
Name = "name",
IsRequired = true,
ParameterType = "path",
DefaultValue = null,
Pattern = @"^projects/[^/]+/locations/[^/]+/instances/[^/]+$",
});
}
}
///
/// 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.
///
/// The body of the request.
///
/// REQUIRED: The resource for which the policy detail is being requested. See [Resource
/// names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this
/// field.
///
public virtual TestIamPermissionsRequest TestIamPermissions(Google.Apis.AIPlatformNotebooks.v1.Data.TestIamPermissionsRequest body, string resource)
{
return new TestIamPermissionsRequest(this.service, body, resource);
}
///
/// 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.
///
public class TestIamPermissionsRequest : AIPlatformNotebooksBaseServiceRequest
{
/// Constructs a new TestIamPermissions request.
public TestIamPermissionsRequest(Google.Apis.Services.IClientService service, Google.Apis.AIPlatformNotebooks.v1.Data.TestIamPermissionsRequest body, string resource) : base(service)
{
Resource = resource;
Body = body;
InitParameters();
}
///
/// REQUIRED: The resource for which the policy detail is being requested. See [Resource
/// names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this
/// field.
///
[Google.Apis.Util.RequestParameterAttribute("resource", Google.Apis.Util.RequestParameterType.Path)]
public virtual string Resource { get; private set; }
/// Gets or sets the body of this request.
Google.Apis.AIPlatformNotebooks.v1.Data.TestIamPermissionsRequest Body { get; set; }
/// Returns the body of the request.
protected override object GetBody() => Body;
/// Gets the method name.
public override string MethodName => "testIamPermissions";
/// Gets the HTTP method.
public override string HttpMethod => "POST";
/// Gets the REST path.
public override string RestPath => "v1/{+resource}:testIamPermissions";
/// Initializes TestIamPermissions parameter list.
protected override void InitParameters()
{
base.InitParameters();
RequestParameters.Add("resource", new Google.Apis.Discovery.Parameter
{
Name = "resource",
IsRequired = true,
ParameterType = "path",
DefaultValue = null,
Pattern = @"^projects/[^/]+/locations/[^/]+/instances/[^/]+$",
});
}
}
/// Update Notebook Instance configurations.
/// The body of the request.
///
/// Required. Format: `projects/{project_id}/locations/{location}/instances/{instance_id}`
///
public virtual UpdateConfigRequest UpdateConfig(Google.Apis.AIPlatformNotebooks.v1.Data.UpdateInstanceConfigRequest body, string name)
{
return new UpdateConfigRequest(this.service, body, name);
}
/// Update Notebook Instance configurations.
public class UpdateConfigRequest : AIPlatformNotebooksBaseServiceRequest
{
/// Constructs a new UpdateConfig request.
public UpdateConfigRequest(Google.Apis.Services.IClientService service, Google.Apis.AIPlatformNotebooks.v1.Data.UpdateInstanceConfigRequest body, string name) : base(service)
{
Name = name;
Body = body;
InitParameters();
}
///
/// Required. Format: `projects/{project_id}/locations/{location}/instances/{instance_id}`
///
[Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)]
public virtual string Name { get; private set; }
/// Gets or sets the body of this request.
Google.Apis.AIPlatformNotebooks.v1.Data.UpdateInstanceConfigRequest Body { get; set; }
/// Returns the body of the request.
protected override object GetBody() => Body;
/// Gets the method name.
public override string MethodName => "updateConfig";
/// Gets the HTTP method.
public override string HttpMethod => "PATCH";
/// Gets the REST path.
public override string RestPath => "v1/{+name}:updateConfig";
/// Initializes UpdateConfig parameter list.
protected override void InitParameters()
{
base.InitParameters();
RequestParameters.Add("name", new Google.Apis.Discovery.Parameter
{
Name = "name",
IsRequired = true,
ParameterType = "path",
DefaultValue = null,
Pattern = @"^projects/[^/]+/locations/[^/]+/instances/[^/]+$",
});
}
}
/// Add/update metadata items for an instance.
/// The body of the request.
///
/// Required. Format: `projects/{project_id}/locations/{location}/instances/{instance_id}`
///
public virtual UpdateMetadataItemsRequest UpdateMetadataItems(Google.Apis.AIPlatformNotebooks.v1.Data.UpdateInstanceMetadataItemsRequest body, string name)
{
return new UpdateMetadataItemsRequest(this.service, body, name);
}
/// Add/update metadata items for an instance.
public class UpdateMetadataItemsRequest : AIPlatformNotebooksBaseServiceRequest
{
/// Constructs a new UpdateMetadataItems request.
public UpdateMetadataItemsRequest(Google.Apis.Services.IClientService service, Google.Apis.AIPlatformNotebooks.v1.Data.UpdateInstanceMetadataItemsRequest body, string name) : base(service)
{
Name = name;
Body = body;
InitParameters();
}
///
/// Required. Format: `projects/{project_id}/locations/{location}/instances/{instance_id}`
///
[Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)]
public virtual string Name { get; private set; }
/// Gets or sets the body of this request.
Google.Apis.AIPlatformNotebooks.v1.Data.UpdateInstanceMetadataItemsRequest Body { get; set; }
/// Returns the body of the request.
protected override object GetBody() => Body;
/// Gets the method name.
public override string MethodName => "updateMetadataItems";
/// Gets the HTTP method.
public override string HttpMethod => "PATCH";
/// Gets the REST path.
public override string RestPath => "v1/{+name}:updateMetadataItems";
/// Initializes UpdateMetadataItems parameter list.
protected override void InitParameters()
{
base.InitParameters();
RequestParameters.Add("name", new Google.Apis.Discovery.Parameter
{
Name = "name",
IsRequired = true,
ParameterType = "path",
DefaultValue = null,
Pattern = @"^projects/[^/]+/locations/[^/]+/instances/[^/]+$",
});
}
}
/// Updates the Shielded instance configuration of a single Instance.
/// The body of the request.
///
/// Required. Format: `projects/{project_id}/locations/{location}/instances/{instance_id}`
///
public virtual UpdateShieldedInstanceConfigRequest UpdateShieldedInstanceConfig(Google.Apis.AIPlatformNotebooks.v1.Data.UpdateShieldedInstanceConfigRequest body, string name)
{
return new UpdateShieldedInstanceConfigRequest(this.service, body, name);
}
/// Updates the Shielded instance configuration of a single Instance.
public class UpdateShieldedInstanceConfigRequest : AIPlatformNotebooksBaseServiceRequest
{
/// Constructs a new UpdateShieldedInstanceConfig request.
public UpdateShieldedInstanceConfigRequest(Google.Apis.Services.IClientService service, Google.Apis.AIPlatformNotebooks.v1.Data.UpdateShieldedInstanceConfigRequest body, string name) : base(service)
{
Name = name;
Body = body;
InitParameters();
}
///
/// Required. Format: `projects/{project_id}/locations/{location}/instances/{instance_id}`
///
[Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)]
public virtual string Name { get; private set; }
/// Gets or sets the body of this request.
Google.Apis.AIPlatformNotebooks.v1.Data.UpdateShieldedInstanceConfigRequest Body { get; set; }
/// Returns the body of the request.
protected override object GetBody() => Body;
/// Gets the method name.
public override string MethodName => "updateShieldedInstanceConfig";
/// Gets the HTTP method.
public override string HttpMethod => "PATCH";
/// Gets the REST path.
public override string RestPath => "v1/{+name}:updateShieldedInstanceConfig";
/// Initializes UpdateShieldedInstanceConfig parameter list.
protected override void InitParameters()
{
base.InitParameters();
RequestParameters.Add("name", new Google.Apis.Discovery.Parameter
{
Name = "name",
IsRequired = true,
ParameterType = "path",
DefaultValue = null,
Pattern = @"^projects/[^/]+/locations/[^/]+/instances/[^/]+$",
});
}
}
/// Upgrades a notebook instance to the latest version.
/// The body of the request.
///
/// Required. Format: `projects/{project_id}/locations/{location}/instances/{instance_id}`
///
public virtual UpgradeRequest Upgrade(Google.Apis.AIPlatformNotebooks.v1.Data.UpgradeInstanceRequest body, string name)
{
return new UpgradeRequest(this.service, body, name);
}
/// Upgrades a notebook instance to the latest version.
public class UpgradeRequest : AIPlatformNotebooksBaseServiceRequest
{
/// Constructs a new Upgrade request.
public UpgradeRequest(Google.Apis.Services.IClientService service, Google.Apis.AIPlatformNotebooks.v1.Data.UpgradeInstanceRequest body, string name) : base(service)
{
Name = name;
Body = body;
InitParameters();
}
///
/// Required. Format: `projects/{project_id}/locations/{location}/instances/{instance_id}`
///
[Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)]
public virtual string Name { get; private set; }
/// Gets or sets the body of this request.
Google.Apis.AIPlatformNotebooks.v1.Data.UpgradeInstanceRequest Body { get; set; }
/// Returns the body of the request.
protected override object GetBody() => Body;
/// Gets the method name.
public override string MethodName => "upgrade";
/// Gets the HTTP method.
public override string HttpMethod => "POST";
/// Gets the REST path.
public override string RestPath => "v1/{+name}:upgrade";
/// Initializes Upgrade parameter list.
protected override void InitParameters()
{
base.InitParameters();
RequestParameters.Add("name", new Google.Apis.Discovery.Parameter
{
Name = "name",
IsRequired = true,
ParameterType = "path",
DefaultValue = null,
Pattern = @"^projects/[^/]+/locations/[^/]+/instances/[^/]+$",
});
}
}
///
/// Allows notebook instances to call this endpoint to upgrade themselves. Do not use this method
/// directly.
///
/// The body of the request.
///
/// Required. Format: `projects/{project_id}/locations/{location}/instances/{instance_id}`
///
public virtual UpgradeInternalRequest UpgradeInternal(Google.Apis.AIPlatformNotebooks.v1.Data.UpgradeInstanceInternalRequest body, string name)
{
return new UpgradeInternalRequest(this.service, body, name);
}
///
/// Allows notebook instances to call this endpoint to upgrade themselves. Do not use this method
/// directly.
///
public class UpgradeInternalRequest : AIPlatformNotebooksBaseServiceRequest
{
/// Constructs a new UpgradeInternal request.
public UpgradeInternalRequest(Google.Apis.Services.IClientService service, Google.Apis.AIPlatformNotebooks.v1.Data.UpgradeInstanceInternalRequest body, string name) : base(service)
{
Name = name;
Body = body;
InitParameters();
}
///
/// Required. Format: `projects/{project_id}/locations/{location}/instances/{instance_id}`
///
[Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)]
public virtual string Name { get; private set; }
/// Gets or sets the body of this request.
Google.Apis.AIPlatformNotebooks.v1.Data.UpgradeInstanceInternalRequest Body { get; set; }
/// Returns the body of the request.
protected override object GetBody() => Body;
/// Gets the method name.
public override string MethodName => "upgradeInternal";
/// Gets the HTTP method.
public override string HttpMethod => "POST";
/// Gets the REST path.
public override string RestPath => "v1/{+name}:upgradeInternal";
/// Initializes UpgradeInternal parameter list.
protected override void InitParameters()
{
base.InitParameters();
RequestParameters.Add("name", new Google.Apis.Discovery.Parameter
{
Name = "name",
IsRequired = true,
ParameterType = "path",
DefaultValue = null,
Pattern = @"^projects/[^/]+/locations/[^/]+/instances/[^/]+$",
});
}
}
}
/// Gets the Operations resource.
public virtual OperationsResource Operations { get; }
/// The "operations" collection of methods.
public class OperationsResource
{
private const string Resource = "operations";
/// The service which this resource belongs to.
private readonly Google.Apis.Services.IClientService service;
/// Constructs a new resource.
public OperationsResource(Google.Apis.Services.IClientService service)
{
this.service = 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`.
///
/// The body of the request.
/// The name of the operation resource to be cancelled.
public virtual CancelRequest Cancel(Google.Apis.AIPlatformNotebooks.v1.Data.CancelOperationRequest body, string name)
{
return new CancelRequest(this.service, body, name);
}
///
/// 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`.
///
public class CancelRequest : AIPlatformNotebooksBaseServiceRequest
{
/// Constructs a new Cancel request.
public CancelRequest(Google.Apis.Services.IClientService service, Google.Apis.AIPlatformNotebooks.v1.Data.CancelOperationRequest body, string name) : base(service)
{
Name = name;
Body = body;
InitParameters();
}
/// The name of the operation resource to be cancelled.
[Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)]
public virtual string Name { get; private set; }
/// Gets or sets the body of this request.
Google.Apis.AIPlatformNotebooks.v1.Data.CancelOperationRequest Body { get; set; }
/// Returns the body of the request.
protected override object GetBody() => Body;
/// Gets the method name.
public override string MethodName => "cancel";
/// Gets the HTTP method.
public override string HttpMethod => "POST";
/// Gets the REST path.
public override string RestPath => "v1/{+name}:cancel";
/// Initializes Cancel parameter list.
protected override void InitParameters()
{
base.InitParameters();
RequestParameters.Add("name", new Google.Apis.Discovery.Parameter
{
Name = "name",
IsRequired = true,
ParameterType = "path",
DefaultValue = null,
Pattern = @"^projects/[^/]+/locations/[^/]+/operations/[^/]+$",
});
}
}
///
/// 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`.
///
/// The name of the operation resource to be deleted.
public virtual DeleteRequest Delete(string name)
{
return new DeleteRequest(this.service, name);
}
///
/// 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`.
///
public class DeleteRequest : AIPlatformNotebooksBaseServiceRequest
{
/// Constructs a new Delete request.
public DeleteRequest(Google.Apis.Services.IClientService service, string name) : base(service)
{
Name = name;
InitParameters();
}
/// The name of the operation resource to be deleted.
[Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)]
public virtual string Name { get; private set; }
/// Gets the method name.
public override string MethodName => "delete";
/// Gets the HTTP method.
public override string HttpMethod => "DELETE";
/// Gets the REST path.
public override string RestPath => "v1/{+name}";
/// Initializes Delete parameter list.
protected override void InitParameters()
{
base.InitParameters();
RequestParameters.Add("name", new Google.Apis.Discovery.Parameter
{
Name = "name",
IsRequired = true,
ParameterType = "path",
DefaultValue = null,
Pattern = @"^projects/[^/]+/locations/[^/]+/operations/[^/]+$",
});
}
}
///
/// 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.
///
/// The name of the operation resource.
public virtual GetRequest Get(string name)
{
return new GetRequest(this.service, name);
}
///
/// 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.
///
public class GetRequest : AIPlatformNotebooksBaseServiceRequest
{
/// Constructs a new Get request.
public GetRequest(Google.Apis.Services.IClientService service, string name) : base(service)
{
Name = name;
InitParameters();
}
/// The name of the operation resource.
[Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)]
public virtual string Name { get; private set; }
/// Gets the method name.
public override string MethodName => "get";
/// Gets the HTTP method.
public override string HttpMethod => "GET";
/// Gets the REST path.
public override string RestPath => "v1/{+name}";
/// Initializes Get parameter list.
protected override void InitParameters()
{
base.InitParameters();
RequestParameters.Add("name", new Google.Apis.Discovery.Parameter
{
Name = "name",
IsRequired = true,
ParameterType = "path",
DefaultValue = null,
Pattern = @"^projects/[^/]+/locations/[^/]+/operations/[^/]+$",
});
}
}
///
/// Lists operations that match the specified filter in the request. If the server doesn't support this
/// method, it returns `UNIMPLEMENTED`.
///
/// The name of the operation's parent resource.
public virtual ListRequest List(string name)
{
return new ListRequest(this.service, name);
}
///
/// Lists operations that match the specified filter in the request. If the server doesn't support this
/// method, it returns `UNIMPLEMENTED`.
///
public class ListRequest : AIPlatformNotebooksBaseServiceRequest
{
/// Constructs a new List request.
public ListRequest(Google.Apis.Services.IClientService service, string name) : base(service)
{
Name = name;
InitParameters();
}
/// The name of the operation's parent resource.
[Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)]
public virtual string Name { get; private set; }
/// The standard list filter.
[Google.Apis.Util.RequestParameterAttribute("filter", Google.Apis.Util.RequestParameterType.Query)]
public virtual string Filter { get; set; }
/// The standard list page size.
[Google.Apis.Util.RequestParameterAttribute("pageSize", Google.Apis.Util.RequestParameterType.Query)]
public virtual System.Nullable PageSize { get; set; }
/// The standard list page token.
[Google.Apis.Util.RequestParameterAttribute("pageToken", Google.Apis.Util.RequestParameterType.Query)]
public virtual string PageToken { get; set; }
///
/// When set to `true`, operations that are reachable are returned as normal, and those that are
/// unreachable are returned in the ListOperationsResponse.unreachable field. This can only be
/// `true` when reading across collections. For example, when `parent` is set to
/// `"projects/example/locations/-"`. This field is not supported by default and will result in an
/// `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product
/// specific documentation.
///
[Google.Apis.Util.RequestParameterAttribute("returnPartialSuccess", Google.Apis.Util.RequestParameterType.Query)]
public virtual System.Nullable ReturnPartialSuccess { get; set; }
/// Gets the method name.
public override string MethodName => "list";
/// Gets the HTTP method.
public override string HttpMethod => "GET";
/// Gets the REST path.
public override string RestPath => "v1/{+name}/operations";
/// Initializes List parameter list.
protected override void InitParameters()
{
base.InitParameters();
RequestParameters.Add("name", new Google.Apis.Discovery.Parameter
{
Name = "name",
IsRequired = true,
ParameterType = "path",
DefaultValue = null,
Pattern = @"^projects/[^/]+/locations/[^/]+$",
});
RequestParameters.Add("filter", new Google.Apis.Discovery.Parameter
{
Name = "filter",
IsRequired = false,
ParameterType = "query",
DefaultValue = null,
Pattern = null,
});
RequestParameters.Add("pageSize", new Google.Apis.Discovery.Parameter
{
Name = "pageSize",
IsRequired = false,
ParameterType = "query",
DefaultValue = null,
Pattern = null,
});
RequestParameters.Add("pageToken", new Google.Apis.Discovery.Parameter
{
Name = "pageToken",
IsRequired = false,
ParameterType = "query",
DefaultValue = null,
Pattern = null,
});
RequestParameters.Add("returnPartialSuccess", new Google.Apis.Discovery.Parameter
{
Name = "returnPartialSuccess",
IsRequired = false,
ParameterType = "query",
DefaultValue = null,
Pattern = null,
});
}
}
}
/// Gets the Runtimes resource.
public virtual RuntimesResource Runtimes { get; }
/// The "runtimes" collection of methods.
public class RuntimesResource
{
private const string Resource = "runtimes";
/// The service which this resource belongs to.
private readonly Google.Apis.Services.IClientService service;
/// Constructs a new resource.
public RuntimesResource(Google.Apis.Services.IClientService service)
{
this.service = service;
}
/// Creates a new Runtime in a given project and location.
/// The body of the request.
/// Required. Format: `parent=projects/{project_id}/locations/{location}`
public virtual CreateRequest Create(Google.Apis.AIPlatformNotebooks.v1.Data.Runtime body, string parent)
{
return new CreateRequest(this.service, body, parent);
}
/// Creates a new Runtime in a given project and location.
public class CreateRequest : AIPlatformNotebooksBaseServiceRequest
{
/// Constructs a new Create request.
public CreateRequest(Google.Apis.Services.IClientService service, Google.Apis.AIPlatformNotebooks.v1.Data.Runtime body, string parent) : base(service)
{
Parent = parent;
Body = body;
InitParameters();
}
/// Required. Format: `parent=projects/{project_id}/locations/{location}`
[Google.Apis.Util.RequestParameterAttribute("parent", Google.Apis.Util.RequestParameterType.Path)]
public virtual string Parent { get; private set; }
/// Idempotent request UUID.
[Google.Apis.Util.RequestParameterAttribute("requestId", Google.Apis.Util.RequestParameterType.Query)]
public virtual string RequestId { get; set; }
/// Required. User-defined unique ID of this Runtime.
[Google.Apis.Util.RequestParameterAttribute("runtimeId", Google.Apis.Util.RequestParameterType.Query)]
public virtual string RuntimeId { get; set; }
/// Gets or sets the body of this request.
Google.Apis.AIPlatformNotebooks.v1.Data.Runtime Body { get; set; }
/// Returns the body of the request.
protected override object GetBody() => Body;
/// Gets the method name.
public override string MethodName => "create";
/// Gets the HTTP method.
public override string HttpMethod => "POST";
/// Gets the REST path.
public override string RestPath => "v1/{+parent}/runtimes";
/// Initializes Create parameter list.
protected override void InitParameters()
{
base.InitParameters();
RequestParameters.Add("parent", new Google.Apis.Discovery.Parameter
{
Name = "parent",
IsRequired = true,
ParameterType = "path",
DefaultValue = null,
Pattern = @"^projects/[^/]+/locations/[^/]+$",
});
RequestParameters.Add("requestId", new Google.Apis.Discovery.Parameter
{
Name = "requestId",
IsRequired = false,
ParameterType = "query",
DefaultValue = null,
Pattern = null,
});
RequestParameters.Add("runtimeId", new Google.Apis.Discovery.Parameter
{
Name = "runtimeId",
IsRequired = false,
ParameterType = "query",
DefaultValue = null,
Pattern = null,
});
}
}
/// Deletes a single Runtime.
///
/// Required. Format: `projects/{project_id}/locations/{location}/runtimes/{runtime_id}`
///
public virtual DeleteRequest Delete(string name)
{
return new DeleteRequest(this.service, name);
}
/// Deletes a single Runtime.
public class DeleteRequest : AIPlatformNotebooksBaseServiceRequest
{
/// Constructs a new Delete request.
public DeleteRequest(Google.Apis.Services.IClientService service, string name) : base(service)
{
Name = name;
InitParameters();
}
///
/// Required. Format: `projects/{project_id}/locations/{location}/runtimes/{runtime_id}`
///
[Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)]
public virtual string Name { get; private set; }
/// Idempotent request UUID.
[Google.Apis.Util.RequestParameterAttribute("requestId", Google.Apis.Util.RequestParameterType.Query)]
public virtual string RequestId { get; set; }
/// Gets the method name.
public override string MethodName => "delete";
/// Gets the HTTP method.
public override string HttpMethod => "DELETE";
/// Gets the REST path.
public override string RestPath => "v1/{+name}";
/// Initializes Delete parameter list.
protected override void InitParameters()
{
base.InitParameters();
RequestParameters.Add("name", new Google.Apis.Discovery.Parameter
{
Name = "name",
IsRequired = true,
ParameterType = "path",
DefaultValue = null,
Pattern = @"^projects/[^/]+/locations/[^/]+/runtimes/[^/]+$",
});
RequestParameters.Add("requestId", new Google.Apis.Discovery.Parameter
{
Name = "requestId",
IsRequired = false,
ParameterType = "query",
DefaultValue = null,
Pattern = null,
});
}
}
/// Creates a Diagnostic File and runs Diagnostic Tool given a Runtime.
/// The body of the request.
///
/// Required. Format: `projects/{project_id}/locations/{location}/runtimes/{runtimes_id}`
///
public virtual DiagnoseRequest Diagnose(Google.Apis.AIPlatformNotebooks.v1.Data.DiagnoseRuntimeRequest body, string name)
{
return new DiagnoseRequest(this.service, body, name);
}
/// Creates a Diagnostic File and runs Diagnostic Tool given a Runtime.
public class DiagnoseRequest : AIPlatformNotebooksBaseServiceRequest
{
/// Constructs a new Diagnose request.
public DiagnoseRequest(Google.Apis.Services.IClientService service, Google.Apis.AIPlatformNotebooks.v1.Data.DiagnoseRuntimeRequest body, string name) : base(service)
{
Name = name;
Body = body;
InitParameters();
}
///
/// Required. Format: `projects/{project_id}/locations/{location}/runtimes/{runtimes_id}`
///
[Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)]
public virtual string Name { get; private set; }
/// Gets or sets the body of this request.
Google.Apis.AIPlatformNotebooks.v1.Data.DiagnoseRuntimeRequest Body { get; set; }
/// Returns the body of the request.
protected override object GetBody() => Body;
/// Gets the method name.
public override string MethodName => "diagnose";
/// Gets the HTTP method.
public override string HttpMethod => "POST";
/// Gets the REST path.
public override string RestPath => "v1/{+name}:diagnose";
/// Initializes Diagnose parameter list.
protected override void InitParameters()
{
base.InitParameters();
RequestParameters.Add("name", new Google.Apis.Discovery.Parameter
{
Name = "name",
IsRequired = true,
ParameterType = "path",
DefaultValue = null,
Pattern = @"^projects/[^/]+/locations/[^/]+/runtimes/[^/]+$",
});
}
}
///
/// Gets details of a single Runtime. The location must be a regional endpoint rather than zonal.
///
///
/// Required. Format: `projects/{project_id}/locations/{location}/runtimes/{runtime_id}`
///
public virtual GetRequest Get(string name)
{
return new GetRequest(this.service, name);
}
///
/// Gets details of a single Runtime. The location must be a regional endpoint rather than zonal.
///
public class GetRequest : AIPlatformNotebooksBaseServiceRequest
{
/// Constructs a new Get request.
public GetRequest(Google.Apis.Services.IClientService service, string name) : base(service)
{
Name = name;
InitParameters();
}
///
/// Required. Format: `projects/{project_id}/locations/{location}/runtimes/{runtime_id}`
///
[Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)]
public virtual string Name { get; private set; }
/// Gets the method name.
public override string MethodName => "get";
/// Gets the HTTP method.
public override string HttpMethod => "GET";
/// Gets the REST path.
public override string RestPath => "v1/{+name}";
/// Initializes Get parameter list.
protected override void InitParameters()
{
base.InitParameters();
RequestParameters.Add("name", new Google.Apis.Discovery.Parameter
{
Name = "name",
IsRequired = true,
ParameterType = "path",
DefaultValue = null,
Pattern = @"^projects/[^/]+/locations/[^/]+/runtimes/[^/]+$",
});
}
}
///
/// Gets the access control policy for a resource. Returns an empty policy if the resource exists and
/// does not have a policy set.
///
///
/// REQUIRED: The resource for which the policy is being requested. See [Resource
/// names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this
/// field.
///
public virtual GetIamPolicyRequest GetIamPolicy(string resource)
{
return new GetIamPolicyRequest(this.service, resource);
}
///
/// Gets the access control policy for a resource. Returns an empty policy if the resource exists and
/// does not have a policy set.
///
public class GetIamPolicyRequest : AIPlatformNotebooksBaseServiceRequest
{
/// Constructs a new GetIamPolicy request.
public GetIamPolicyRequest(Google.Apis.Services.IClientService service, string resource) : base(service)
{
Resource = resource;
InitParameters();
}
///
/// REQUIRED: The resource for which the policy is being requested. See [Resource
/// names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this
/// field.
///
[Google.Apis.Util.RequestParameterAttribute("resource", Google.Apis.Util.RequestParameterType.Path)]
public virtual string Resource { get; private set; }
///
/// 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](https://cloud.google.com/iam/help/conditions/resource-policies).
///
[Google.Apis.Util.RequestParameterAttribute("options.requestedPolicyVersion", Google.Apis.Util.RequestParameterType.Query)]
public virtual System.Nullable OptionsRequestedPolicyVersion { get; set; }
/// Gets the method name.
public override string MethodName => "getIamPolicy";
/// Gets the HTTP method.
public override string HttpMethod => "GET";
/// Gets the REST path.
public override string RestPath => "v1/{+resource}:getIamPolicy";
/// Initializes GetIamPolicy parameter list.
protected override void InitParameters()
{
base.InitParameters();
RequestParameters.Add("resource", new Google.Apis.Discovery.Parameter
{
Name = "resource",
IsRequired = true,
ParameterType = "path",
DefaultValue = null,
Pattern = @"^projects/[^/]+/locations/[^/]+/runtimes/[^/]+$",
});
RequestParameters.Add("options.requestedPolicyVersion", new Google.Apis.Discovery.Parameter
{
Name = "options.requestedPolicyVersion",
IsRequired = false,
ParameterType = "query",
DefaultValue = null,
Pattern = null,
});
}
}
/// Lists Runtimes in a given project and location.
/// Required. Format: `parent=projects/{project_id}/locations/{location}`
public virtual ListRequest List(string parent)
{
return new ListRequest(this.service, parent);
}
/// Lists Runtimes in a given project and location.
public class ListRequest : AIPlatformNotebooksBaseServiceRequest
{
/// Constructs a new List request.
public ListRequest(Google.Apis.Services.IClientService service, string parent) : base(service)
{
Parent = parent;
InitParameters();
}
/// Required. Format: `parent=projects/{project_id}/locations/{location}`
[Google.Apis.Util.RequestParameterAttribute("parent", Google.Apis.Util.RequestParameterType.Path)]
public virtual string Parent { get; private set; }
/// Optional. List filter.
[Google.Apis.Util.RequestParameterAttribute("filter", Google.Apis.Util.RequestParameterType.Query)]
public virtual string Filter { get; set; }
///
/// Optional. Sort results. Supported values are "name", "name desc" or "" (unsorted).
///
[Google.Apis.Util.RequestParameterAttribute("orderBy", Google.Apis.Util.RequestParameterType.Query)]
public virtual string OrderBy { get; set; }
/// Maximum return size of the list call.
[Google.Apis.Util.RequestParameterAttribute("pageSize", Google.Apis.Util.RequestParameterType.Query)]
public virtual System.Nullable PageSize { get; set; }
///
/// A previous returned page token that can be used to continue listing from the last result.
///
[Google.Apis.Util.RequestParameterAttribute("pageToken", Google.Apis.Util.RequestParameterType.Query)]
public virtual string PageToken { get; set; }
/// Gets the method name.
public override string MethodName => "list";
/// Gets the HTTP method.
public override string HttpMethod => "GET";
/// Gets the REST path.
public override string RestPath => "v1/{+parent}/runtimes";
/// Initializes List parameter list.
protected override void InitParameters()
{
base.InitParameters();
RequestParameters.Add("parent", new Google.Apis.Discovery.Parameter
{
Name = "parent",
IsRequired = true,
ParameterType = "path",
DefaultValue = null,
Pattern = @"^projects/[^/]+/locations/[^/]+$",
});
RequestParameters.Add("filter", new Google.Apis.Discovery.Parameter
{
Name = "filter",
IsRequired = false,
ParameterType = "query",
DefaultValue = null,
Pattern = null,
});
RequestParameters.Add("orderBy", new Google.Apis.Discovery.Parameter
{
Name = "orderBy",
IsRequired = false,
ParameterType = "query",
DefaultValue = null,
Pattern = null,
});
RequestParameters.Add("pageSize", new Google.Apis.Discovery.Parameter
{
Name = "pageSize",
IsRequired = false,
ParameterType = "query",
DefaultValue = null,
Pattern = null,
});
RequestParameters.Add("pageToken", new Google.Apis.Discovery.Parameter
{
Name = "pageToken",
IsRequired = false,
ParameterType = "query",
DefaultValue = null,
Pattern = null,
});
}
}
/// Migrate an existing Runtime to a new Workbench Instance.
/// The body of the request.
///
/// Required. Format: `projects/{project_id}/locations/{location}/runtimes/{runtime_id}`
///
public virtual MigrateRequest Migrate(Google.Apis.AIPlatformNotebooks.v1.Data.MigrateRuntimeRequest body, string name)
{
return new MigrateRequest(this.service, body, name);
}
/// Migrate an existing Runtime to a new Workbench Instance.
public class MigrateRequest : AIPlatformNotebooksBaseServiceRequest
{
/// Constructs a new Migrate request.
public MigrateRequest(Google.Apis.Services.IClientService service, Google.Apis.AIPlatformNotebooks.v1.Data.MigrateRuntimeRequest body, string name) : base(service)
{
Name = name;
Body = body;
InitParameters();
}
///
/// Required. Format: `projects/{project_id}/locations/{location}/runtimes/{runtime_id}`
///
[Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)]
public virtual string Name { get; private set; }
/// Gets or sets the body of this request.
Google.Apis.AIPlatformNotebooks.v1.Data.MigrateRuntimeRequest Body { get; set; }
/// Returns the body of the request.
protected override object GetBody() => Body;
/// Gets the method name.
public override string MethodName => "migrate";
/// Gets the HTTP method.
public override string HttpMethod => "POST";
/// Gets the REST path.
public override string RestPath => "v1/{+name}:migrate";
/// Initializes Migrate parameter list.
protected override void InitParameters()
{
base.InitParameters();
RequestParameters.Add("name", new Google.Apis.Discovery.Parameter
{
Name = "name",
IsRequired = true,
ParameterType = "path",
DefaultValue = null,
Pattern = @"^projects/[^/]+/locations/[^/]+/runtimes/[^/]+$",
});
}
}
/// Update Notebook Runtime configuration.
/// The body of the request.
///
/// Output only. The resource name of the runtime. Format:
/// `projects/{project}/locations/{location}/runtimes/{runtimeId}`
///
public virtual PatchRequest Patch(Google.Apis.AIPlatformNotebooks.v1.Data.Runtime body, string name)
{
return new PatchRequest(this.service, body, name);
}
/// Update Notebook Runtime configuration.
public class PatchRequest : AIPlatformNotebooksBaseServiceRequest
{
/// Constructs a new Patch request.
public PatchRequest(Google.Apis.Services.IClientService service, Google.Apis.AIPlatformNotebooks.v1.Data.Runtime body, string name) : base(service)
{
Name = name;
Body = body;
InitParameters();
}
///
/// Output only. The resource name of the runtime. Format:
/// `projects/{project}/locations/{location}/runtimes/{runtimeId}`
///
[Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)]
public virtual string Name { get; private set; }
/// Idempotent request UUID.
[Google.Apis.Util.RequestParameterAttribute("requestId", Google.Apis.Util.RequestParameterType.Query)]
public virtual string RequestId { get; set; }
///
/// Required. Specifies the path, relative to `Runtime`, of the field to update. For example, to
/// change the software configuration kernels, the `update_mask` parameter would be specified as
/// `software_config.kernels`, and the `PATCH` 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`
///
[Google.Apis.Util.RequestParameterAttribute("updateMask", Google.Apis.Util.RequestParameterType.Query)]
public virtual object UpdateMask { get; set; }
/// Gets or sets the body of this request.
Google.Apis.AIPlatformNotebooks.v1.Data.Runtime Body { get; set; }
/// Returns the body of the request.
protected override object GetBody() => Body;
/// Gets the method name.
public override string MethodName => "patch";
/// Gets the HTTP method.
public override string HttpMethod => "PATCH";
/// Gets the REST path.
public override string RestPath => "v1/{+name}";
/// Initializes Patch parameter list.
protected override void InitParameters()
{
base.InitParameters();
RequestParameters.Add("name", new Google.Apis.Discovery.Parameter
{
Name = "name",
IsRequired = true,
ParameterType = "path",
DefaultValue = null,
Pattern = @"^projects/[^/]+/locations/[^/]+/runtimes/[^/]+$",
});
RequestParameters.Add("requestId", new Google.Apis.Discovery.Parameter
{
Name = "requestId",
IsRequired = false,
ParameterType = "query",
DefaultValue = null,
Pattern = null,
});
RequestParameters.Add("updateMask", new Google.Apis.Discovery.Parameter
{
Name = "updateMask",
IsRequired = false,
ParameterType = "query",
DefaultValue = null,
Pattern = null,
});
}
}
///
/// Gets an access token for the consumer service account that the customer attached to the runtime.
/// Only accessible from the tenant instance.
///
/// The body of the request.
///
/// Required. Format: `projects/{project_id}/locations/{location}/runtimes/{runtime_id}`
///
public virtual RefreshRuntimeTokenInternalRequest RefreshRuntimeTokenInternal(Google.Apis.AIPlatformNotebooks.v1.Data.RefreshRuntimeTokenInternalRequest body, string name)
{
return new RefreshRuntimeTokenInternalRequest(this.service, body, name);
}
///
/// Gets an access token for the consumer service account that the customer attached to the runtime.
/// Only accessible from the tenant instance.
///
public class RefreshRuntimeTokenInternalRequest : AIPlatformNotebooksBaseServiceRequest
{
/// Constructs a new RefreshRuntimeTokenInternal request.
public RefreshRuntimeTokenInternalRequest(Google.Apis.Services.IClientService service, Google.Apis.AIPlatformNotebooks.v1.Data.RefreshRuntimeTokenInternalRequest body, string name) : base(service)
{
Name = name;
Body = body;
InitParameters();
}
///
/// Required. Format: `projects/{project_id}/locations/{location}/runtimes/{runtime_id}`
///
[Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)]
public virtual string Name { get; private set; }
/// Gets or sets the body of this request.
Google.Apis.AIPlatformNotebooks.v1.Data.RefreshRuntimeTokenInternalRequest Body { get; set; }
/// Returns the body of the request.
protected override object GetBody() => Body;
/// Gets the method name.
public override string MethodName => "refreshRuntimeTokenInternal";
/// Gets the HTTP method.
public override string HttpMethod => "POST";
/// Gets the REST path.
public override string RestPath => "v1/{+name}:refreshRuntimeTokenInternal";
/// Initializes RefreshRuntimeTokenInternal parameter list.
protected override void InitParameters()
{
base.InitParameters();
RequestParameters.Add("name", new Google.Apis.Discovery.Parameter
{
Name = "name",
IsRequired = true,
ParameterType = "path",
DefaultValue = null,
Pattern = @"^projects/[^/]+/locations/[^/]+/runtimes/[^/]+$",
});
}
}
/// Reports and processes a runtime event.
/// The body of the request.
///
/// Required. Format: `projects/{project_id}/locations/{location}/runtimes/{runtime_id}`
///
public virtual ReportEventRequest ReportEvent(Google.Apis.AIPlatformNotebooks.v1.Data.ReportRuntimeEventRequest body, string name)
{
return new ReportEventRequest(this.service, body, name);
}
/// Reports and processes a runtime event.
public class ReportEventRequest : AIPlatformNotebooksBaseServiceRequest
{
/// Constructs a new ReportEvent request.
public ReportEventRequest(Google.Apis.Services.IClientService service, Google.Apis.AIPlatformNotebooks.v1.Data.ReportRuntimeEventRequest body, string name) : base(service)
{
Name = name;
Body = body;
InitParameters();
}
///
/// Required. Format: `projects/{project_id}/locations/{location}/runtimes/{runtime_id}`
///
[Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)]
public virtual string Name { get; private set; }
/// Gets or sets the body of this request.
Google.Apis.AIPlatformNotebooks.v1.Data.ReportRuntimeEventRequest Body { get; set; }
/// Returns the body of the request.
protected override object GetBody() => Body;
/// Gets the method name.
public override string MethodName => "reportEvent";
/// Gets the HTTP method.
public override string HttpMethod => "POST";
/// Gets the REST path.
public override string RestPath => "v1/{+name}:reportEvent";
/// Initializes ReportEvent parameter list.
protected override void InitParameters()
{
base.InitParameters();
RequestParameters.Add("name", new Google.Apis.Discovery.Parameter
{
Name = "name",
IsRequired = true,
ParameterType = "path",
DefaultValue = null,
Pattern = @"^projects/[^/]+/locations/[^/]+/runtimes/[^/]+$",
});
}
}
/// Resets a Managed Notebook Runtime.
/// The body of the request.
///
/// Required. Format: `projects/{project_id}/locations/{location}/runtimes/{runtime_id}`
///
public virtual ResetRequest Reset(Google.Apis.AIPlatformNotebooks.v1.Data.ResetRuntimeRequest body, string name)
{
return new ResetRequest(this.service, body, name);
}
/// Resets a Managed Notebook Runtime.
public class ResetRequest : AIPlatformNotebooksBaseServiceRequest
{
/// Constructs a new Reset request.
public ResetRequest(Google.Apis.Services.IClientService service, Google.Apis.AIPlatformNotebooks.v1.Data.ResetRuntimeRequest body, string name) : base(service)
{
Name = name;
Body = body;
InitParameters();
}
///
/// Required. Format: `projects/{project_id}/locations/{location}/runtimes/{runtime_id}`
///
[Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)]
public virtual string Name { get; private set; }
/// Gets or sets the body of this request.
Google.Apis.AIPlatformNotebooks.v1.Data.ResetRuntimeRequest Body { get; set; }
/// Returns the body of the request.
protected override object GetBody() => Body;
/// Gets the method name.
public override string MethodName => "reset";
/// Gets the HTTP method.
public override string HttpMethod => "POST";
/// Gets the REST path.
public override string RestPath => "v1/{+name}:reset";
/// Initializes Reset parameter list.
protected override void InitParameters()
{
base.InitParameters();
RequestParameters.Add("name", new Google.Apis.Discovery.Parameter
{
Name = "name",
IsRequired = true,
ParameterType = "path",
DefaultValue = null,
Pattern = @"^projects/[^/]+/locations/[^/]+/runtimes/[^/]+$",
});
}
}
///
/// Sets the access control policy on the specified resource. Replaces any existing policy. Can return
/// `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.
///
/// The body of the request.
///
/// REQUIRED: The resource for which the policy is being specified. See [Resource
/// names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this
/// field.
///
public virtual SetIamPolicyRequest SetIamPolicy(Google.Apis.AIPlatformNotebooks.v1.Data.SetIamPolicyRequest body, string resource)
{
return new SetIamPolicyRequest(this.service, body, resource);
}
///
/// Sets the access control policy on the specified resource. Replaces any existing policy. Can return
/// `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.
///
public class SetIamPolicyRequest : AIPlatformNotebooksBaseServiceRequest
{
/// Constructs a new SetIamPolicy request.
public SetIamPolicyRequest(Google.Apis.Services.IClientService service, Google.Apis.AIPlatformNotebooks.v1.Data.SetIamPolicyRequest body, string resource) : base(service)
{
Resource = resource;
Body = body;
InitParameters();
}
///
/// REQUIRED: The resource for which the policy is being specified. See [Resource
/// names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this
/// field.
///
[Google.Apis.Util.RequestParameterAttribute("resource", Google.Apis.Util.RequestParameterType.Path)]
public virtual string Resource { get; private set; }
/// Gets or sets the body of this request.
Google.Apis.AIPlatformNotebooks.v1.Data.SetIamPolicyRequest Body { get; set; }
/// Returns the body of the request.
protected override object GetBody() => Body;
/// Gets the method name.
public override string MethodName => "setIamPolicy";
/// Gets the HTTP method.
public override string HttpMethod => "POST";
/// Gets the REST path.
public override string RestPath => "v1/{+resource}:setIamPolicy";
/// Initializes SetIamPolicy parameter list.
protected override void InitParameters()
{
base.InitParameters();
RequestParameters.Add("resource", new Google.Apis.Discovery.Parameter
{
Name = "resource",
IsRequired = true,
ParameterType = "path",
DefaultValue = null,
Pattern = @"^projects/[^/]+/locations/[^/]+/runtimes/[^/]+$",
});
}
}
///
/// 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
///
/// The body of the request.
///
/// Required. Format: `projects/{project_id}/locations/{location}/runtimes/{runtime_id}`
///
public virtual StartRequest Start(Google.Apis.AIPlatformNotebooks.v1.Data.StartRuntimeRequest body, string name)
{
return new StartRequest(this.service, body, name);
}
///
/// 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
///
public class StartRequest : AIPlatformNotebooksBaseServiceRequest
{
/// Constructs a new Start request.
public StartRequest(Google.Apis.Services.IClientService service, Google.Apis.AIPlatformNotebooks.v1.Data.StartRuntimeRequest body, string name) : base(service)
{
Name = name;
Body = body;
InitParameters();
}
///
/// Required. Format: `projects/{project_id}/locations/{location}/runtimes/{runtime_id}`
///
[Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)]
public virtual string Name { get; private set; }
/// Gets or sets the body of this request.
Google.Apis.AIPlatformNotebooks.v1.Data.StartRuntimeRequest Body { get; set; }
/// Returns the body of the request.
protected override object GetBody() => Body;
/// Gets the method name.
public override string MethodName => "start";
/// Gets the HTTP method.
public override string HttpMethod => "POST";
/// Gets the REST path.
public override string RestPath => "v1/{+name}:start";
/// Initializes Start parameter list.
protected override void InitParameters()
{
base.InitParameters();
RequestParameters.Add("name", new Google.Apis.Discovery.Parameter
{
Name = "name",
IsRequired = true,
ParameterType = "path",
DefaultValue = null,
Pattern = @"^projects/[^/]+/locations/[^/]+/runtimes/[^/]+$",
});
}
}
///
/// 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
///
/// The body of the request.
///
/// Required. Format: `projects/{project_id}/locations/{location}/runtimes/{runtime_id}`
///
public virtual StopRequest Stop(Google.Apis.AIPlatformNotebooks.v1.Data.StopRuntimeRequest body, string name)
{
return new StopRequest(this.service, body, name);
}
///
/// 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
///
public class StopRequest : AIPlatformNotebooksBaseServiceRequest
{
/// Constructs a new Stop request.
public StopRequest(Google.Apis.Services.IClientService service, Google.Apis.AIPlatformNotebooks.v1.Data.StopRuntimeRequest body, string name) : base(service)
{
Name = name;
Body = body;
InitParameters();
}
///
/// Required. Format: `projects/{project_id}/locations/{location}/runtimes/{runtime_id}`
///
[Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)]
public virtual string Name { get; private set; }
/// Gets or sets the body of this request.
Google.Apis.AIPlatformNotebooks.v1.Data.StopRuntimeRequest Body { get; set; }
/// Returns the body of the request.
protected override object GetBody() => Body;
/// Gets the method name.
public override string MethodName => "stop";
/// Gets the HTTP method.
public override string HttpMethod => "POST";
/// Gets the REST path.
public override string RestPath => "v1/{+name}:stop";
/// Initializes Stop parameter list.
protected override void InitParameters()
{
base.InitParameters();
RequestParameters.Add("name", new Google.Apis.Discovery.Parameter
{
Name = "name",
IsRequired = true,
ParameterType = "path",
DefaultValue = null,
Pattern = @"^projects/[^/]+/locations/[^/]+/runtimes/[^/]+$",
});
}
}
/// Switch a Managed Notebook Runtime.
/// The body of the request.
///
/// Required. Format: `projects/{project_id}/locations/{location}/runtimes/{runtime_id}`
///
public virtual AIPlatformNotebooksSwitchRequest AIPlatformNotebooksSwitch(Google.Apis.AIPlatformNotebooks.v1.Data.SwitchRuntimeRequest body, string name)
{
return new AIPlatformNotebooksSwitchRequest(this.service, body, name);
}
/// Switch a Managed Notebook Runtime.
public class AIPlatformNotebooksSwitchRequest : AIPlatformNotebooksBaseServiceRequest
{
/// Constructs a new AIPlatformNotebooksSwitch request.
public AIPlatformNotebooksSwitchRequest(Google.Apis.Services.IClientService service, Google.Apis.AIPlatformNotebooks.v1.Data.SwitchRuntimeRequest body, string name) : base(service)
{
Name = name;
Body = body;
InitParameters();
}
///
/// Required. Format: `projects/{project_id}/locations/{location}/runtimes/{runtime_id}`
///
[Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)]
public virtual string Name { get; private set; }
/// Gets or sets the body of this request.
Google.Apis.AIPlatformNotebooks.v1.Data.SwitchRuntimeRequest Body { get; set; }
/// Returns the body of the request.
protected override object GetBody() => Body;
/// Gets the method name.
public override string MethodName => "switch";
/// Gets the HTTP method.
public override string HttpMethod => "POST";
/// Gets the REST path.
public override string RestPath => "v1/{+name}:switch";
/// Initializes AIPlatformNotebooksSwitch parameter list.
protected override void InitParameters()
{
base.InitParameters();
RequestParameters.Add("name", new Google.Apis.Discovery.Parameter
{
Name = "name",
IsRequired = true,
ParameterType = "path",
DefaultValue = null,
Pattern = @"^projects/[^/]+/locations/[^/]+/runtimes/[^/]+$",
});
}
}
///
/// 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.
///
/// The body of the request.
///
/// REQUIRED: The resource for which the policy detail is being requested. See [Resource
/// names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this
/// field.
///
public virtual TestIamPermissionsRequest TestIamPermissions(Google.Apis.AIPlatformNotebooks.v1.Data.TestIamPermissionsRequest body, string resource)
{
return new TestIamPermissionsRequest(this.service, body, resource);
}
///
/// 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.
///
public class TestIamPermissionsRequest : AIPlatformNotebooksBaseServiceRequest
{
/// Constructs a new TestIamPermissions request.
public TestIamPermissionsRequest(Google.Apis.Services.IClientService service, Google.Apis.AIPlatformNotebooks.v1.Data.TestIamPermissionsRequest body, string resource) : base(service)
{
Resource = resource;
Body = body;
InitParameters();
}
///
/// REQUIRED: The resource for which the policy detail is being requested. See [Resource
/// names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this
/// field.
///
[Google.Apis.Util.RequestParameterAttribute("resource", Google.Apis.Util.RequestParameterType.Path)]
public virtual string Resource { get; private set; }
/// Gets or sets the body of this request.
Google.Apis.AIPlatformNotebooks.v1.Data.TestIamPermissionsRequest Body { get; set; }
/// Returns the body of the request.
protected override object GetBody() => Body;
/// Gets the method name.
public override string MethodName => "testIamPermissions";
/// Gets the HTTP method.
public override string HttpMethod => "POST";
/// Gets the REST path.
public override string RestPath => "v1/{+resource}:testIamPermissions";
/// Initializes TestIamPermissions parameter list.
protected override void InitParameters()
{
base.InitParameters();
RequestParameters.Add("resource", new Google.Apis.Discovery.Parameter
{
Name = "resource",
IsRequired = true,
ParameterType = "path",
DefaultValue = null,
Pattern = @"^projects/[^/]+/locations/[^/]+/runtimes/[^/]+$",
});
}
}
/// Upgrades a Managed Notebook Runtime to the latest version.
/// The body of the request.
///
/// Required. Format: `projects/{project_id}/locations/{location}/runtimes/{runtime_id}`
///
public virtual UpgradeRequest Upgrade(Google.Apis.AIPlatformNotebooks.v1.Data.UpgradeRuntimeRequest body, string name)
{
return new UpgradeRequest(this.service, body, name);
}
/// Upgrades a Managed Notebook Runtime to the latest version.
public class UpgradeRequest : AIPlatformNotebooksBaseServiceRequest
{
/// Constructs a new Upgrade request.
public UpgradeRequest(Google.Apis.Services.IClientService service, Google.Apis.AIPlatformNotebooks.v1.Data.UpgradeRuntimeRequest body, string name) : base(service)
{
Name = name;
Body = body;
InitParameters();
}
///
/// Required. Format: `projects/{project_id}/locations/{location}/runtimes/{runtime_id}`
///
[Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)]
public virtual string Name { get; private set; }
/// Gets or sets the body of this request.
Google.Apis.AIPlatformNotebooks.v1.Data.UpgradeRuntimeRequest Body { get; set; }
/// Returns the body of the request.
protected override object GetBody() => Body;
/// Gets the method name.
public override string MethodName => "upgrade";
/// Gets the HTTP method.
public override string HttpMethod => "POST";
/// Gets the REST path.
public override string RestPath => "v1/{+name}:upgrade";
/// Initializes Upgrade parameter list.
protected override void InitParameters()
{
base.InitParameters();
RequestParameters.Add("name", new Google.Apis.Discovery.Parameter
{
Name = "name",
IsRequired = true,
ParameterType = "path",
DefaultValue = null,
Pattern = @"^projects/[^/]+/locations/[^/]+/runtimes/[^/]+$",
});
}
}
}
/// Gets the Schedules resource.
public virtual SchedulesResource Schedules { get; }
/// The "schedules" collection of methods.
public class SchedulesResource
{
private const string Resource = "schedules";
/// The service which this resource belongs to.
private readonly Google.Apis.Services.IClientService service;
/// Constructs a new resource.
public SchedulesResource(Google.Apis.Services.IClientService service)
{
this.service = service;
}
/// Creates a new Scheduled Notebook in a given project and location.
/// The body of the request.
/// Required. Format: `parent=projects/{project_id}/locations/{location}`
public virtual CreateRequest Create(Google.Apis.AIPlatformNotebooks.v1.Data.Schedule body, string parent)
{
return new CreateRequest(this.service, body, parent);
}
/// Creates a new Scheduled Notebook in a given project and location.
public class CreateRequest : AIPlatformNotebooksBaseServiceRequest
{
/// Constructs a new Create request.
public CreateRequest(Google.Apis.Services.IClientService service, Google.Apis.AIPlatformNotebooks.v1.Data.Schedule body, string parent) : base(service)
{
Parent = parent;
Body = body;
InitParameters();
}
/// Required. Format: `parent=projects/{project_id}/locations/{location}`
[Google.Apis.Util.RequestParameterAttribute("parent", Google.Apis.Util.RequestParameterType.Path)]
public virtual string Parent { get; private set; }
/// Required. User-defined unique ID of this schedule.
[Google.Apis.Util.RequestParameterAttribute("scheduleId", Google.Apis.Util.RequestParameterType.Query)]
public virtual string ScheduleId { get; set; }
/// Gets or sets the body of this request.
Google.Apis.AIPlatformNotebooks.v1.Data.Schedule Body { get; set; }
/// Returns the body of the request.
protected override object GetBody() => Body;
/// Gets the method name.
public override string MethodName => "create";
/// Gets the HTTP method.
public override string HttpMethod => "POST";
/// Gets the REST path.
public override string RestPath => "v1/{+parent}/schedules";
/// Initializes Create parameter list.
protected override void InitParameters()
{
base.InitParameters();
RequestParameters.Add("parent", new Google.Apis.Discovery.Parameter
{
Name = "parent",
IsRequired = true,
ParameterType = "path",
DefaultValue = null,
Pattern = @"^projects/[^/]+/locations/[^/]+$",
});
RequestParameters.Add("scheduleId", new Google.Apis.Discovery.Parameter
{
Name = "scheduleId",
IsRequired = false,
ParameterType = "query",
DefaultValue = null,
Pattern = null,
});
}
}
/// Deletes schedule and all underlying jobs
///
/// Required. Format: `projects/{project_id}/locations/{location}/schedules/{schedule_id}`
///
public virtual DeleteRequest Delete(string name)
{
return new DeleteRequest(this.service, name);
}
/// Deletes schedule and all underlying jobs
public class DeleteRequest : AIPlatformNotebooksBaseServiceRequest
{
/// Constructs a new Delete request.
public DeleteRequest(Google.Apis.Services.IClientService service, string name) : base(service)
{
Name = name;
InitParameters();
}
///
/// Required. Format: `projects/{project_id}/locations/{location}/schedules/{schedule_id}`
///
[Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)]
public virtual string Name { get; private set; }
/// Gets the method name.
public override string MethodName => "delete";
/// Gets the HTTP method.
public override string HttpMethod => "DELETE";
/// Gets the REST path.
public override string RestPath => "v1/{+name}";
/// Initializes Delete parameter list.
protected override void InitParameters()
{
base.InitParameters();
RequestParameters.Add("name", new Google.Apis.Discovery.Parameter
{
Name = "name",
IsRequired = true,
ParameterType = "path",
DefaultValue = null,
Pattern = @"^projects/[^/]+/locations/[^/]+/schedules/[^/]+$",
});
}
}
/// Gets details of schedule
///
/// Required. Format: `projects/{project_id}/locations/{location}/schedules/{schedule_id}`
///
public virtual GetRequest Get(string name)
{
return new GetRequest(this.service, name);
}
/// Gets details of schedule
public class GetRequest : AIPlatformNotebooksBaseServiceRequest
{
/// Constructs a new Get request.
public GetRequest(Google.Apis.Services.IClientService service, string name) : base(service)
{
Name = name;
InitParameters();
}
///
/// Required. Format: `projects/{project_id}/locations/{location}/schedules/{schedule_id}`
///
[Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)]
public virtual string Name { get; private set; }
/// Gets the method name.
public override string MethodName => "get";
/// Gets the HTTP method.
public override string HttpMethod => "GET";
/// Gets the REST path.
public override string RestPath => "v1/{+name}";
/// Initializes Get parameter list.
protected override void InitParameters()
{
base.InitParameters();
RequestParameters.Add("name", new Google.Apis.Discovery.Parameter
{
Name = "name",
IsRequired = true,
ParameterType = "path",
DefaultValue = null,
Pattern = @"^projects/[^/]+/locations/[^/]+/schedules/[^/]+$",
});
}
}
/// Lists schedules in a given project and location.
/// Required. Format: `parent=projects/{project_id}/locations/{location}`
public virtual ListRequest List(string parent)
{
return new ListRequest(this.service, parent);
}
/// Lists schedules in a given project and location.
public class ListRequest : AIPlatformNotebooksBaseServiceRequest
{
/// Constructs a new List request.
public ListRequest(Google.Apis.Services.IClientService service, string parent) : base(service)
{
Parent = parent;
InitParameters();
}
/// Required. Format: `parent=projects/{project_id}/locations/{location}`
[Google.Apis.Util.RequestParameterAttribute("parent", Google.Apis.Util.RequestParameterType.Path)]
public virtual string Parent { get; private set; }
/// Filter applied to resulting schedules.
[Google.Apis.Util.RequestParameterAttribute("filter", Google.Apis.Util.RequestParameterType.Query)]
public virtual string Filter { get; set; }
/// Field to order results by.
[Google.Apis.Util.RequestParameterAttribute("orderBy", Google.Apis.Util.RequestParameterType.Query)]
public virtual string OrderBy { get; set; }
/// Maximum return size of the list call.
[Google.Apis.Util.RequestParameterAttribute("pageSize", Google.Apis.Util.RequestParameterType.Query)]
public virtual System.Nullable PageSize { get; set; }
///
/// A previous returned page token that can be used to continue listing from the last result.
///
[Google.Apis.Util.RequestParameterAttribute("pageToken", Google.Apis.Util.RequestParameterType.Query)]
public virtual string PageToken { get; set; }
/// Gets the method name.
public override string MethodName => "list";
/// Gets the HTTP method.
public override string HttpMethod => "GET";
/// Gets the REST path.
public override string RestPath => "v1/{+parent}/schedules";
/// Initializes List parameter list.
protected override void InitParameters()
{
base.InitParameters();
RequestParameters.Add("parent", new Google.Apis.Discovery.Parameter
{
Name = "parent",
IsRequired = true,
ParameterType = "path",
DefaultValue = null,
Pattern = @"^projects/[^/]+/locations/[^/]+$",
});
RequestParameters.Add("filter", new Google.Apis.Discovery.Parameter
{
Name = "filter",
IsRequired = false,
ParameterType = "query",
DefaultValue = null,
Pattern = null,
});
RequestParameters.Add("orderBy", new Google.Apis.Discovery.Parameter
{
Name = "orderBy",
IsRequired = false,
ParameterType = "query",
DefaultValue = null,
Pattern = null,
});
RequestParameters.Add("pageSize", new Google.Apis.Discovery.Parameter
{
Name = "pageSize",
IsRequired = false,
ParameterType = "query",
DefaultValue = null,
Pattern = null,
});
RequestParameters.Add("pageToken", new Google.Apis.Discovery.Parameter
{
Name = "pageToken",
IsRequired = false,
ParameterType = "query",
DefaultValue = null,
Pattern = null,
});
}
}
/// Triggers execution of an existing schedule.
/// The body of the request.
///
/// Required. Format: `parent=projects/{project_id}/locations/{location}/schedules/{schedule_id}`
///
public virtual TriggerRequest Trigger(Google.Apis.AIPlatformNotebooks.v1.Data.TriggerScheduleRequest body, string name)
{
return new TriggerRequest(this.service, body, name);
}
/// Triggers execution of an existing schedule.
public class TriggerRequest : AIPlatformNotebooksBaseServiceRequest
{
/// Constructs a new Trigger request.
public TriggerRequest(Google.Apis.Services.IClientService service, Google.Apis.AIPlatformNotebooks.v1.Data.TriggerScheduleRequest body, string name) : base(service)
{
Name = name;
Body = body;
InitParameters();
}
///
/// Required. Format: `parent=projects/{project_id}/locations/{location}/schedules/{schedule_id}`
///
[Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)]
public virtual string Name { get; private set; }
/// Gets or sets the body of this request.
Google.Apis.AIPlatformNotebooks.v1.Data.TriggerScheduleRequest Body { get; set; }
/// Returns the body of the request.
protected override object GetBody() => Body;
/// Gets the method name.
public override string MethodName => "trigger";
/// Gets the HTTP method.
public override string HttpMethod => "POST";
/// Gets the REST path.
public override string RestPath => "v1/{+name}:trigger";
/// Initializes Trigger parameter list.
protected override void InitParameters()
{
base.InitParameters();
RequestParameters.Add("name", new Google.Apis.Discovery.Parameter
{
Name = "name",
IsRequired = true,
ParameterType = "path",
DefaultValue = null,
Pattern = @"^projects/[^/]+/locations/[^/]+/schedules/[^/]+$",
});
}
}
}
/// Gets information about a location.
/// Resource name for the location.
public virtual GetRequest Get(string name)
{
return new GetRequest(this.service, name);
}
/// Gets information about a location.
public class GetRequest : AIPlatformNotebooksBaseServiceRequest
{
/// Constructs a new Get request.
public GetRequest(Google.Apis.Services.IClientService service, string name) : base(service)
{
Name = name;
InitParameters();
}
/// Resource name for the location.
[Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)]
public virtual string Name { get; private set; }
/// Gets the method name.
public override string MethodName => "get";
/// Gets the HTTP method.
public override string HttpMethod => "GET";
/// Gets the REST path.
public override string RestPath => "v1/{+name}";
/// Initializes Get parameter list.
protected override void InitParameters()
{
base.InitParameters();
RequestParameters.Add("name", new Google.Apis.Discovery.Parameter
{
Name = "name",
IsRequired = true,
ParameterType = "path",
DefaultValue = null,
Pattern = @"^projects/[^/]+/locations/[^/]+$",
});
}
}
/// Lists information about the supported locations for this service.
/// The resource that owns the locations collection, if applicable.
public virtual ListRequest List(string name)
{
return new ListRequest(this.service, name);
}
/// Lists information about the supported locations for this service.
public class ListRequest : AIPlatformNotebooksBaseServiceRequest
{
/// Constructs a new List request.
public ListRequest(Google.Apis.Services.IClientService service, string name) : base(service)
{
Name = name;
InitParameters();
}
/// The resource that owns the locations collection, if applicable.
[Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)]
public virtual string Name { get; private set; }
///
/// Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented
/// otherwise. This is primarily for internal usage.
///
[Google.Apis.Util.RequestParameterAttribute("extraLocationTypes", Google.Apis.Util.RequestParameterType.Query)]
public virtual Google.Apis.Util.Repeatable ExtraLocationTypes { get; set; }
///
/// 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](https://google.aip.dev/160).
///
[Google.Apis.Util.RequestParameterAttribute("filter", Google.Apis.Util.RequestParameterType.Query)]
public virtual string Filter { get; set; }
///
/// The maximum number of results to return. If not set, the service selects a default.
///
[Google.Apis.Util.RequestParameterAttribute("pageSize", Google.Apis.Util.RequestParameterType.Query)]
public virtual System.Nullable PageSize { get; set; }
///
/// A page token received from the `next_page_token` field in the response. Send that page token to
/// receive the subsequent page.
///
[Google.Apis.Util.RequestParameterAttribute("pageToken", Google.Apis.Util.RequestParameterType.Query)]
public virtual string PageToken { get; set; }
/// Gets the method name.
public override string MethodName => "list";
/// Gets the HTTP method.
public override string HttpMethod => "GET";
/// Gets the REST path.
public override string RestPath => "v1/{+name}/locations";
/// Initializes List parameter list.
protected override void InitParameters()
{
base.InitParameters();
RequestParameters.Add("name", new Google.Apis.Discovery.Parameter
{
Name = "name",
IsRequired = true,
ParameterType = "path",
DefaultValue = null,
Pattern = @"^projects/[^/]+$",
});
RequestParameters.Add("extraLocationTypes", new Google.Apis.Discovery.Parameter
{
Name = "extraLocationTypes",
IsRequired = false,
ParameterType = "query",
DefaultValue = null,
Pattern = null,
});
RequestParameters.Add("filter", new Google.Apis.Discovery.Parameter
{
Name = "filter",
IsRequired = false,
ParameterType = "query",
DefaultValue = null,
Pattern = null,
});
RequestParameters.Add("pageSize", new Google.Apis.Discovery.Parameter
{
Name = "pageSize",
IsRequired = false,
ParameterType = "query",
DefaultValue = null,
Pattern = null,
});
RequestParameters.Add("pageToken", new Google.Apis.Discovery.Parameter
{
Name = "pageToken",
IsRequired = false,
ParameterType = "query",
DefaultValue = null,
Pattern = null,
});
}
}
}
}
}
namespace Google.Apis.AIPlatformNotebooks.v1.Data
{
///
/// Definition of a hardware accelerator. Note that not all combinations of `type` and `core_count` are valid. See
/// [GPUs on Compute Engine](https://cloud.google.com/compute/docs/gpus/#gpus-list) to find a valid combination.
/// TPUs are not supported.
///
public class AcceleratorConfig : Google.Apis.Requests.IDirectResponseSchema
{
/// Count of cores of this accelerator.
[Newtonsoft.Json.JsonPropertyAttribute("coreCount")]
public virtual System.Nullable CoreCount { get; set; }
/// Type of this accelerator.
[Newtonsoft.Json.JsonPropertyAttribute("type")]
public virtual string Type { get; set; }
/// The ETag of the item.
public virtual string ETag { get; set; }
}
/// Associates `members`, or principals, with a `role`.
public class Binding : Google.Apis.Requests.IDirectResponseSchema
{
///
/// The condition that is associated with this binding. If the condition evaluates to `true`, then this binding
/// applies to the current request. If the condition evaluates to `false`, then this binding does not apply to
/// the current request. However, a different role binding might grant the same role to one or more of the
/// principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM
/// documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
///
[Newtonsoft.Json.JsonPropertyAttribute("condition")]
public virtual Expr Condition { get; set; }
///
/// Specifies the principals requesting access for a Google Cloud resource. `members` can have the following
/// values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a
/// Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated
/// with a Google account or a service account. Does not include identities that come from external identity
/// providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a
/// specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address
/// that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. *
/// `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes
/// service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For
/// example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that
/// represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain
/// (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. *
/// `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
/// A single identity in a workforce identity pool. *
/// `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All
/// workforce identities in a group. *
/// `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
/// All workforce identities with a specific attribute value. *
/// `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a
/// workforce identity pool. *
/// `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`:
/// A single identity in a workload identity pool. *
/// `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`:
/// A workload identity pool group. *
/// `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
/// All identities in a workload identity pool with a certain attribute. *
/// `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`:
/// All identities in a workload identity pool. * `deleted:user:{emailid}?uid={uniqueid}`: An email address
/// (plus unique identifier) representing a user that has been recently deleted. For example,
/// `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to
/// `user:{emailid}` and the recovered user retains the role in the binding. *
/// `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a
/// service account that has been recently deleted. For example,
/// `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted,
/// this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the
/// binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing
/// a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`.
/// If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role
/// in the binding. *
/// `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
/// Deleted single identity in a workforce identity pool. For example,
/// `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
///
[Newtonsoft.Json.JsonPropertyAttribute("members")]
public virtual System.Collections.Generic.IList Members { get; set; }
///
/// Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`,
/// or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM
/// documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined
/// roles, see [here](https://cloud.google.com/iam/docs/understanding-roles).
///
[Newtonsoft.Json.JsonPropertyAttribute("role")]
public virtual string Role { get; set; }
/// The ETag of the item.
public virtual string ETag { get; set; }
}
/// Definition of the boot image used by the Runtime. Used to facilitate runtime upgradeability.
public class BootImage : Google.Apis.Requests.IDirectResponseSchema
{
/// The ETag of the item.
public virtual string ETag { get; set; }
}
/// The request message for Operations.CancelOperation.
public class CancelOperationRequest : Google.Apis.Requests.IDirectResponseSchema
{
/// The ETag of the item.
public virtual string ETag { get; set; }
}
///
/// Definition of a container image for starting a notebook instance with the environment installed in a container.
///
public class ContainerImage : Google.Apis.Requests.IDirectResponseSchema
{
///
/// Required. The path to the container image repository. For example: `gcr.io/{project_id}/{image_name}`
///
[Newtonsoft.Json.JsonPropertyAttribute("repository")]
public virtual string Repository { get; set; }
/// The tag of the container image. If not specified, this defaults to the latest tag.
[Newtonsoft.Json.JsonPropertyAttribute("tag")]
public virtual string Tag { get; set; }
/// The ETag of the item.
public virtual string ETag { get; set; }
}
/// Parameters used in Dataproc JobType executions.
public class DataprocParameters : Google.Apis.Requests.IDirectResponseSchema
{
///
/// URI for cluster used to run Dataproc execution. Format:
/// `projects/{PROJECT_ID}/regions/{REGION}/clusters/{CLUSTER_NAME}`
///
[Newtonsoft.Json.JsonPropertyAttribute("cluster")]
public virtual string Cluster { get; set; }
/// The ETag of the item.
public virtual string ETag { get; set; }
}
/// Request for creating a notebook instance diagnostic file.
public class DiagnoseInstanceRequest : Google.Apis.Requests.IDirectResponseSchema
{
/// Required. Defines flags that are used to run the diagnostic tool
[Newtonsoft.Json.JsonPropertyAttribute("diagnosticConfig")]
public virtual DiagnosticConfig DiagnosticConfig { get; set; }
/// Optional. Maximum amount of time in minutes before the operation times out.
[Newtonsoft.Json.JsonPropertyAttribute("timeoutMinutes")]
public virtual System.Nullable TimeoutMinutes { get; set; }
/// The ETag of the item.
public virtual string ETag { get; set; }
}
/// Request for creating a notebook instance diagnostic file.
public class DiagnoseRuntimeRequest : Google.Apis.Requests.IDirectResponseSchema
{
/// Required. Defines flags that are used to run the diagnostic tool
[Newtonsoft.Json.JsonPropertyAttribute("diagnosticConfig")]
public virtual DiagnosticConfig DiagnosticConfig { get; set; }
/// Optional. Maximum amount of time in minutes before the operation times out.
[Newtonsoft.Json.JsonPropertyAttribute("timeoutMinutes")]
public virtual System.Nullable TimeoutMinutes { get; set; }
/// The ETag of the item.
public virtual string ETag { get; set; }
}
/// Defines flags that are used to run the diagnostic tool
public class DiagnosticConfig : Google.Apis.Requests.IDirectResponseSchema
{
/// Optional. Enables flag to copy all `/home/jupyter` folder contents
[Newtonsoft.Json.JsonPropertyAttribute("copyHomeFilesFlagEnabled")]
public virtual System.Nullable CopyHomeFilesFlagEnabled { get; set; }
///
/// Required. User Cloud Storage bucket location (REQUIRED). Must be formatted with path prefix
/// (`gs://$GCS_BUCKET`). Permissions: User Managed Notebooks: - storage.buckets.writer: Must be given to the
/// project's service account attached to VM. Google Managed Notebooks: - storage.buckets.writer: Must be given
/// to the project's service account or user credentials attached to VM depending on authentication mode. Cloud
/// Storage bucket Log file will be written to `gs://$GCS_BUCKET/$RELATIVE_PATH/$VM_DATE_$TIME.tar.gz`
///
[Newtonsoft.Json.JsonPropertyAttribute("gcsBucket")]
public virtual string GcsBucket { get; set; }
/// Optional. Enables flag to capture packets from the instance for 30 seconds
[Newtonsoft.Json.JsonPropertyAttribute("packetCaptureFlagEnabled")]
public virtual System.Nullable PacketCaptureFlagEnabled { get; set; }
///
/// Optional. Defines the relative storage path in the Cloud Storage bucket where the diagnostic logs will be
/// written: Default path will be the root directory of the Cloud Storage bucket
/// (`gs://$GCS_BUCKET/$DATE_$TIME.tar.gz`) Example of full path where Log file will be written:
/// `gs://$GCS_BUCKET/$RELATIVE_PATH/`
///
[Newtonsoft.Json.JsonPropertyAttribute("relativePath")]
public virtual string RelativePath { get; set; }
/// Optional. Enables flag to repair service for instance
[Newtonsoft.Json.JsonPropertyAttribute("repairFlagEnabled")]
public virtual System.Nullable RepairFlagEnabled { get; set; }
/// The ETag of the item.
public virtual string ETag { get; set; }
}
/// An instance-attached disk resource.
public class Disk : Google.Apis.Requests.IDirectResponseSchema
{
///
/// Indicates whether the disk will be auto-deleted when the instance is deleted (but not when the disk is
/// detached from the instance).
///
[Newtonsoft.Json.JsonPropertyAttribute("autoDelete")]
public virtual System.Nullable AutoDelete { get; set; }
///
/// Indicates that this is a boot disk. The virtual machine will use the first partition of the disk for its
/// root filesystem.
///
[Newtonsoft.Json.JsonPropertyAttribute("boot")]
public virtual System.Nullable Boot { get; set; }
///
/// Indicates a unique device name of your choice that is reflected into the `/dev/disk/by-id/google-*` tree of
/// a Linux operating system running within the instance. This name can be used to reference the device for
/// mounting, resizing, and so on, from within the instance. If not specified, the server chooses a default
/// device name to apply to this disk, in the form persistent-disk-x, where x is a number assigned by Google
/// Compute Engine.This field is only applicable for persistent disks.
///
[Newtonsoft.Json.JsonPropertyAttribute("deviceName")]
public virtual string DeviceName { get; set; }
/// Indicates the size of the disk in base-2 GB.
[Newtonsoft.Json.JsonPropertyAttribute("diskSizeGb")]
public virtual System.Nullable DiskSizeGb { get; set; }
///
/// Indicates a list of features to enable on the guest operating system. Applicable only for bootable images.
/// Read Enabling guest operating system features to see a list of available options.
///
[Newtonsoft.Json.JsonPropertyAttribute("guestOsFeatures")]
public virtual System.Collections.Generic.IList GuestOsFeatures { get; set; }
///
/// A zero-based index to this disk, where 0 is reserved for the boot disk. If you have many disks attached to
/// an instance, each disk would have a unique index number.
///
[Newtonsoft.Json.JsonPropertyAttribute("index")]
public virtual System.Nullable Index { get; set; }
///
/// Indicates the disk interface to use for attaching this disk, which is either SCSI or NVME. The default is
/// SCSI. Persistent disks must always use SCSI and the request will fail if you attempt to attach a persistent
/// disk in any other format than SCSI. Local SSDs can use either NVME or SCSI. For performance characteristics
/// of SCSI over NVMe, see Local SSD performance. Valid values: * `NVME` * `SCSI`
///
[Newtonsoft.Json.JsonPropertyAttribute("interface")]
public virtual string Interface__ { get; set; }
/// Type of the resource. Always compute#attachedDisk for attached disks.
[Newtonsoft.Json.JsonPropertyAttribute("kind")]
public virtual string Kind { get; set; }
///
/// A list of publicly visible licenses. Reserved for Google's use. A License represents billing and aggregate
/// usage data for public and marketplace images.
///
[Newtonsoft.Json.JsonPropertyAttribute("licenses")]
public virtual System.Collections.Generic.IList Licenses { get; set; }
///
/// The mode in which to attach this disk, either `READ_WRITE` or `READ_ONLY`. If not specified, the default is
/// to attach the disk in `READ_WRITE` mode. Valid values: * `READ_ONLY` * `READ_WRITE`
///
[Newtonsoft.Json.JsonPropertyAttribute("mode")]
public virtual string Mode { get; set; }
/// Indicates a valid partial or full URL to an existing Persistent Disk resource.
[Newtonsoft.Json.JsonPropertyAttribute("source")]
public virtual string Source { get; set; }
///
/// Indicates the type of the disk, either `SCRATCH` or `PERSISTENT`. Valid values: * `PERSISTENT` * `SCRATCH`
///
[Newtonsoft.Json.JsonPropertyAttribute("type")]
public virtual string Type { get; set; }
/// The ETag of the item.
public virtual string ETag { get; set; }
}
///
/// A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical
/// example is to use it as the request or the response type of an API method. For instance: service Foo { rpc
/// Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
///
public class Empty : Google.Apis.Requests.IDirectResponseSchema
{
/// The ETag of the item.
public virtual string ETag { get; set; }
}
///
/// Represents a custom encryption key configuration that can be applied to a resource. This will encrypt all disks
/// in Virtual Machine.
///
public class EncryptionConfig : Google.Apis.Requests.IDirectResponseSchema
{
///
/// The Cloud KMS resource identifier of the customer-managed encryption key used to protect a resource, such as
/// a disks. It has the following format:
/// `projects/{PROJECT_ID}/locations/{REGION}/keyRings/{KEY_RING_NAME}/cryptoKeys/{KEY_NAME}`
///
[Newtonsoft.Json.JsonPropertyAttribute("kmsKey")]
public virtual string KmsKey { get; set; }
/// The ETag of the item.
public virtual string ETag { get; set; }
}
/// Definition of a software environment that is used to start a notebook instance.
public class Environment : Google.Apis.Requests.IDirectResponseSchema
{
/// Use a container image to start the notebook instance.
[Newtonsoft.Json.JsonPropertyAttribute("containerImage")]
public virtual ContainerImage ContainerImage { get; set; }
private string _createTimeRaw;
private object _createTime;
/// Output only. The time at which this environment was created.
[Newtonsoft.Json.JsonPropertyAttribute("createTime")]
public virtual string CreateTimeRaw
{
get => _createTimeRaw;
set
{
_createTime = Google.Apis.Util.Utilities.DeserializeForGoogleFormat(value);
_createTimeRaw = value;
}
}
/// representation of .
[Newtonsoft.Json.JsonIgnoreAttribute]
[System.ObsoleteAttribute("This property is obsolete and may behave unexpectedly; please use CreateTimeDateTimeOffset instead.")]
public virtual object CreateTime
{
get => _createTime;
set
{
_createTimeRaw = Google.Apis.Util.Utilities.SerializeForGoogleFormat(value);
_createTime = value;
}
}
/// representation of .
[Newtonsoft.Json.JsonIgnoreAttribute]
public virtual System.DateTimeOffset? CreateTimeDateTimeOffset
{
get => Google.Apis.Util.DiscoveryFormat.ParseGoogleDateTimeToDateTimeOffset(CreateTimeRaw);
set => CreateTimeRaw = Google.Apis.Util.DiscoveryFormat.FormatDateTimeOffsetToGoogleDateTime(value);
}
/// A brief description of this environment.
[Newtonsoft.Json.JsonPropertyAttribute("description")]
public virtual string Description { get; set; }
/// Display name of this environment for the UI.
[Newtonsoft.Json.JsonPropertyAttribute("displayName")]
public virtual string DisplayName { get; set; }
///
/// Output only. Name of this environment. Format:
/// `projects/{project_id}/locations/{location}/environments/{environment_id}`
///
[Newtonsoft.Json.JsonPropertyAttribute("name")]
public virtual string Name { get; set; }
///
/// Path to a Bash script that automatically runs after a notebook instance fully boots up. The path must be a
/// URL or Cloud Storage path. Example: `"gs://path-to-file/file-name"`
///
[Newtonsoft.Json.JsonPropertyAttribute("postStartupScript")]
public virtual string PostStartupScript { get; set; }
/// Use a Compute Engine VM image to start the notebook instance.
[Newtonsoft.Json.JsonPropertyAttribute("vmImage")]
public virtual VmImage VmImage { get; set; }
/// The ETag of the item.
public virtual string ETag { get; set; }
}
/// The definition of an Event for a managed / semi-managed notebook instance.
public class Event : Google.Apis.Requests.IDirectResponseSchema
{
/// Optional. Event details. This field is used to pass event information.
[Newtonsoft.Json.JsonPropertyAttribute("details")]
public virtual System.Collections.Generic.IDictionary Details { get; set; }
private string _reportTimeRaw;
private object _reportTime;
/// Event report time.
[Newtonsoft.Json.JsonPropertyAttribute("reportTime")]
public virtual string ReportTimeRaw
{
get => _reportTimeRaw;
set
{
_reportTime = Google.Apis.Util.Utilities.DeserializeForGoogleFormat(value);
_reportTimeRaw = value;
}
}
/// representation of .
[Newtonsoft.Json.JsonIgnoreAttribute]
[System.ObsoleteAttribute("This property is obsolete and may behave unexpectedly; please use ReportTimeDateTimeOffset instead.")]
public virtual object ReportTime
{
get => _reportTime;
set
{
_reportTimeRaw = Google.Apis.Util.Utilities.SerializeForGoogleFormat(value);
_reportTime = value;
}
}
/// representation of .
[Newtonsoft.Json.JsonIgnoreAttribute]
public virtual System.DateTimeOffset? ReportTimeDateTimeOffset
{
get => Google.Apis.Util.DiscoveryFormat.ParseGoogleDateTimeToDateTimeOffset(ReportTimeRaw);
set => ReportTimeRaw = Google.Apis.Util.DiscoveryFormat.FormatDateTimeOffsetToGoogleDateTime(value);
}
/// Event type.
[Newtonsoft.Json.JsonPropertyAttribute("type")]
public virtual string Type { get; set; }
/// The ETag of the item.
public virtual string ETag { get; set; }
}
/// The definition of a single executed notebook.
public class Execution : Google.Apis.Requests.IDirectResponseSchema
{
private string _createTimeRaw;
private object _createTime;
/// Output only. Time the Execution was instantiated.
[Newtonsoft.Json.JsonPropertyAttribute("createTime")]
public virtual string CreateTimeRaw
{
get => _createTimeRaw;
set
{
_createTime = Google.Apis.Util.Utilities.DeserializeForGoogleFormat(value);
_createTimeRaw = value;
}
}
/// representation of .
[Newtonsoft.Json.JsonIgnoreAttribute]
[System.ObsoleteAttribute("This property is obsolete and may behave unexpectedly; please use CreateTimeDateTimeOffset instead.")]
public virtual object CreateTime
{
get => _createTime;
set
{
_createTimeRaw = Google.Apis.Util.Utilities.SerializeForGoogleFormat(value);
_createTime = value;
}
}
/// representation of .
[Newtonsoft.Json.JsonIgnoreAttribute]
public virtual System.DateTimeOffset? CreateTimeDateTimeOffset
{
get => Google.Apis.Util.DiscoveryFormat.ParseGoogleDateTimeToDateTimeOffset(CreateTimeRaw);
set => CreateTimeRaw = Google.Apis.Util.DiscoveryFormat.FormatDateTimeOffsetToGoogleDateTime(value);
}
/// A brief description of this execution.
[Newtonsoft.Json.JsonPropertyAttribute("description")]
public virtual string Description { get; set; }
///
/// Output only. Name used for UI purposes. Name can only contain alphanumeric characters and underscores '_'.
///
[Newtonsoft.Json.JsonPropertyAttribute("displayName")]
public virtual string DisplayName { get; set; }
/// execute metadata including name, hardware spec, region, labels, etc.
[Newtonsoft.Json.JsonPropertyAttribute("executionTemplate")]
public virtual ExecutionTemplate ExecutionTemplate { get; set; }
/// Output only. The URI of the external job used to execute the notebook.
[Newtonsoft.Json.JsonPropertyAttribute("jobUri")]
public virtual string JobUri { get; set; }
///
/// Output only. The resource name of the execute. Format:
/// `projects/{project_id}/locations/{location}/executions/{execution_id}`
///
[Newtonsoft.Json.JsonPropertyAttribute("name")]
public virtual string Name { get; set; }
/// Output notebook file generated by this execution
[Newtonsoft.Json.JsonPropertyAttribute("outputNotebookFile")]
public virtual string OutputNotebookFile { get; set; }
/// Output only. State of the underlying AI Platform job.
[Newtonsoft.Json.JsonPropertyAttribute("state")]
public virtual string State { get; set; }
private string _updateTimeRaw;
private object _updateTime;
/// Output only. Time the Execution was last updated.
[Newtonsoft.Json.JsonPropertyAttribute("updateTime")]
public virtual string UpdateTimeRaw
{
get => _updateTimeRaw;
set
{
_updateTime = Google.Apis.Util.Utilities.DeserializeForGoogleFormat(value);
_updateTimeRaw = value;
}
}
/// representation of .
[Newtonsoft.Json.JsonIgnoreAttribute]
[System.ObsoleteAttribute("This property is obsolete and may behave unexpectedly; please use UpdateTimeDateTimeOffset instead.")]
public virtual object UpdateTime
{
get => _updateTime;
set
{
_updateTimeRaw = Google.Apis.Util.Utilities.SerializeForGoogleFormat(value);
_updateTime = value;
}
}
/// representation of .
[Newtonsoft.Json.JsonIgnoreAttribute]
public virtual System.DateTimeOffset? UpdateTimeDateTimeOffset
{
get => Google.Apis.Util.DiscoveryFormat.ParseGoogleDateTimeToDateTimeOffset(UpdateTimeRaw);
set => UpdateTimeRaw = Google.Apis.Util.DiscoveryFormat.FormatDateTimeOffsetToGoogleDateTime(value);
}
/// The ETag of the item.
public virtual string ETag { get; set; }
}
/// The description a notebook execution workload.
public class ExecutionTemplate : Google.Apis.Requests.IDirectResponseSchema
{
/// Configuration (count and accelerator type) for hardware running notebook execution.
[Newtonsoft.Json.JsonPropertyAttribute("acceleratorConfig")]
public virtual SchedulerAcceleratorConfig AcceleratorConfig { get; set; }
///
/// Container Image URI to a DLVM Example: 'gcr.io/deeplearning-platform-release/base-cu100' More examples can
/// be found at: https://cloud.google.com/ai-platform/deep-learning-containers/docs/choosing-container
///
[Newtonsoft.Json.JsonPropertyAttribute("containerImageUri")]
public virtual string ContainerImageUri { get; set; }
/// Parameters used in Dataproc JobType executions.
[Newtonsoft.Json.JsonPropertyAttribute("dataprocParameters")]
public virtual DataprocParameters DataprocParameters { get; set; }
///
/// Path to the notebook file to execute. Must be in a Google Cloud Storage bucket. Format:
/// `gs://{bucket_name}/{folder}/{notebook_file_name}` Ex:
/// `gs://notebook_user/scheduled_notebooks/sentiment_notebook.ipynb`
///
[Newtonsoft.Json.JsonPropertyAttribute("inputNotebookFile")]
public virtual string InputNotebookFile { get; set; }
/// The type of Job to be used on this execution.
[Newtonsoft.Json.JsonPropertyAttribute("jobType")]
public virtual string JobType { get; set; }
///
/// Name of the kernel spec to use. This must be specified if the kernel spec name on the execution target does
/// not match the name in the input notebook file.
///
[Newtonsoft.Json.JsonPropertyAttribute("kernelSpec")]
public virtual string KernelSpec { get; set; }
///
/// Labels for execution. If execution is scheduled, a field included will be 'nbs-scheduled'. Otherwise, it is
/// an immediate execution, and an included field will be 'nbs-immediate'. Use fields to efficiently index
/// between various types of executions.
///
[Newtonsoft.Json.JsonPropertyAttribute("labels")]
public virtual System.Collections.Generic.IDictionary Labels { get; set; }
///
/// Specifies the type of virtual machine to use for your training job's master worker. You must specify this
/// field when `scaleTier` is set to `CUSTOM`. You can use certain Compute Engine machine types directly in this
/// field. The following types are supported: - `n1-standard-4` - `n1-standard-8` - `n1-standard-16` -
/// `n1-standard-32` - `n1-standard-64` - `n1-standard-96` - `n1-highmem-2` - `n1-highmem-4` - `n1-highmem-8` -
/// `n1-highmem-16` - `n1-highmem-32` - `n1-highmem-64` - `n1-highmem-96` - `n1-highcpu-16` - `n1-highcpu-32` -
/// `n1-highcpu-64` - `n1-highcpu-96` Alternatively, you can use the following legacy machine types: -
/// `standard` - `large_model` - `complex_model_s` - `complex_model_m` - `complex_model_l` - `standard_gpu` -
/// `complex_model_m_gpu` - `complex_model_l_gpu` - `standard_p100` - `complex_model_m_p100` - `standard_v100` -
/// `large_model_v100` - `complex_model_m_v100` - `complex_model_l_v100` Finally, if you want to use a TPU for
/// training, specify `cloud_tpu` in this field. Learn more about the [special configuration options for
/// training with
/// TPU](https://cloud.google.com/ai-platform/training/docs/using-tpus#configuring_a_custom_tpu_machine).
///
[Newtonsoft.Json.JsonPropertyAttribute("masterType")]
public virtual string MasterType { get; set; }
///
/// Path to the notebook folder to write to. Must be in a Google Cloud Storage bucket path. Format:
/// `gs://{bucket_name}/{folder}` Ex: `gs://notebook_user/scheduled_notebooks`
///
[Newtonsoft.Json.JsonPropertyAttribute("outputNotebookFolder")]
public virtual string OutputNotebookFolder { get; set; }
/// Parameters used within the 'input_notebook_file' notebook.
[Newtonsoft.Json.JsonPropertyAttribute("parameters")]
public virtual string Parameters { get; set; }
///
/// Parameters to be overridden in the notebook during execution. Ref
/// https://papermill.readthedocs.io/en/latest/usage-parameterize.html on how to specifying parameters in the
/// input notebook and pass them here in an YAML file. Ex:
/// `gs://notebook_user/scheduled_notebooks/sentiment_notebook_params.yaml`
///
[Newtonsoft.Json.JsonPropertyAttribute("paramsYamlFile")]
public virtual string ParamsYamlFile { get; set; }
///
/// Required. Scale tier of the hardware used for notebook execution. DEPRECATED Will be discontinued. As right
/// now only CUSTOM is supported.
///
[Newtonsoft.Json.JsonPropertyAttribute("scaleTier")]
public virtual string ScaleTier { get; set; }
///
/// The email address of a service account to use when running the execution. You must have the
/// `iam.serviceAccounts.actAs` permission for the specified service account.
///
[Newtonsoft.Json.JsonPropertyAttribute("serviceAccount")]
public virtual string ServiceAccount { get; set; }
///
/// The name of a Vertex AI [Tensorboard] resource to which this execution will upload Tensorboard logs. Format:
/// `projects/{project}/locations/{location}/tensorboards/{tensorboard}`
///
[Newtonsoft.Json.JsonPropertyAttribute("tensorboard")]
public virtual string Tensorboard { get; set; }
/// Parameters used in Vertex AI JobType executions.
[Newtonsoft.Json.JsonPropertyAttribute("vertexAiParameters")]
public virtual VertexAIParameters VertexAiParameters { get; set; }
/// The ETag of the item.
public virtual string ETag { get; set; }
}
///
/// Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression
/// language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example
/// (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars"
/// expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description:
/// "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email"
/// Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly
/// visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data
/// Manipulation): title: "Notification string" description: "Create a notification string with a timestamp."
/// expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that
/// may be referenced within an expression are determined by the service that evaluates it. See the service
/// documentation for additional information.
///
public class Expr : Google.Apis.Requests.IDirectResponseSchema
{
///
/// Optional. Description of the expression. This is a longer text which describes the expression, e.g. when
/// hovered over it in a UI.
///
[Newtonsoft.Json.JsonPropertyAttribute("description")]
public virtual string Description { get; set; }
/// Textual representation of an expression in Common Expression Language syntax.
[Newtonsoft.Json.JsonPropertyAttribute("expression")]
public virtual string Expression { get; set; }
///
/// Optional. String indicating the location of the expression for error reporting, e.g. a file name and a
/// position in the file.
///
[Newtonsoft.Json.JsonPropertyAttribute("location")]
public virtual string Location { get; set; }
///
/// Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs
/// which allow to enter the expression.
///
[Newtonsoft.Json.JsonPropertyAttribute("title")]
public virtual string Title { get; set; }
/// The ETag of the item.
public virtual string ETag { get; set; }
}
/// Response for checking if a notebook instance is healthy.
public class GetInstanceHealthResponse : Google.Apis.Requests.IDirectResponseSchema
{
///
/// Output only. Additional information about instance health. Example: healthInfo": {
/// "docker_proxy_agent_status": "1", "docker_status": "1", "jupyterlab_api_status": "-1", "jupyterlab_status":
/// "-1", "updated": "2020-10-18 09:40:03.573409" }
///
[Newtonsoft.Json.JsonPropertyAttribute("healthInfo")]
public virtual System.Collections.Generic.IDictionary HealthInfo { get; set; }
/// Output only. Runtime health_state.
[Newtonsoft.Json.JsonPropertyAttribute("healthState")]
public virtual string HealthState { get; set; }
/// The ETag of the item.
public virtual string ETag { get; set; }
}
/// Guest OS features for boot disk.
public class GuestOsFeature : Google.Apis.Requests.IDirectResponseSchema
{
///
/// The ID of a supported feature. Read Enabling guest operating system features to see a list of available
/// options. Valid values: * `FEATURE_TYPE_UNSPECIFIED` * `MULTI_IP_SUBNET` * `SECURE_BOOT` * `UEFI_COMPATIBLE`
/// * `VIRTIO_SCSI_MULTIQUEUE` * `WINDOWS`
///
[Newtonsoft.Json.JsonPropertyAttribute("type")]
public virtual string Type { get; set; }
/// The ETag of the item.
public virtual string ETag { get; set; }
}
/// The definition of a notebook instance.
public class Instance : Google.Apis.Requests.IDirectResponseSchema
{
///
/// The hardware accelerator used on this instance. If you use accelerators, make sure that your configuration
/// has [enough vCPUs and memory to support the `machine_type` you have
/// selected](https://cloud.google.com/compute/docs/gpus/#gpus-list).
///
[Newtonsoft.Json.JsonPropertyAttribute("acceleratorConfig")]
public virtual AcceleratorConfig AcceleratorConfig { get; set; }
///
/// Input only. The size of the boot disk in GB attached to this instance, up to a maximum of 64000 GB (64 TB).
/// The minimum recommended value is 100 GB. If not specified, this defaults to 100.
///
[Newtonsoft.Json.JsonPropertyAttribute("bootDiskSizeGb")]
public virtual System.Nullable BootDiskSizeGb { get; set; }
///
/// Input only. The type of the boot disk attached to this instance, defaults to standard persistent disk
/// (`PD_STANDARD`).
///
[Newtonsoft.Json.JsonPropertyAttribute("bootDiskType")]
public virtual string BootDiskType { get; set; }
///
/// Optional. Flag to enable ip forwarding or not, default false/off.
/// https://cloud.google.com/vpc/docs/using-routes#canipforward
///
[Newtonsoft.Json.JsonPropertyAttribute("canIpForward")]
public virtual System.Nullable CanIpForward { get; set; }
/// Use a container image to start the notebook instance.
[Newtonsoft.Json.JsonPropertyAttribute("containerImage")]
public virtual ContainerImage ContainerImage { get; set; }
private string _createTimeRaw;
private object _createTime;
/// Output only. Instance creation time.
[Newtonsoft.Json.JsonPropertyAttribute("createTime")]
public virtual string CreateTimeRaw
{
get => _createTimeRaw;
set
{
_createTime = Google.Apis.Util.Utilities.DeserializeForGoogleFormat(value);
_createTimeRaw = value;
}
}
/// representation of .
[Newtonsoft.Json.JsonIgnoreAttribute]
[System.ObsoleteAttribute("This property is obsolete and may behave unexpectedly; please use CreateTimeDateTimeOffset instead.")]
public virtual object CreateTime
{
get => _createTime;
set
{
_createTimeRaw = Google.Apis.Util.Utilities.SerializeForGoogleFormat(value);
_createTime = value;
}
}
/// representation of .
[Newtonsoft.Json.JsonIgnoreAttribute]
public virtual System.DateTimeOffset? CreateTimeDateTimeOffset
{
get => Google.Apis.Util.DiscoveryFormat.ParseGoogleDateTimeToDateTimeOffset(CreateTimeRaw);
set => CreateTimeRaw = Google.Apis.Util.DiscoveryFormat.FormatDateTimeOffsetToGoogleDateTime(value);
}
/// Output only. Email address of entity that sent original CreateInstance request.
[Newtonsoft.Json.JsonPropertyAttribute("creator")]
public virtual string Creator { get; set; }
///
/// Specify a custom Cloud Storage path where the GPU driver is stored. If not specified, we'll automatically
/// choose from official GPU drivers.
///
[Newtonsoft.Json.JsonPropertyAttribute("customGpuDriverPath")]
public virtual string CustomGpuDriverPath { get; set; }
///
/// Input only. The size of the data disk in GB attached to this instance, up to a maximum of 64000 GB (64 TB).
/// You can choose the size of the data disk based on how big your notebooks and data are. If not specified,
/// this defaults to 100.
///
[Newtonsoft.Json.JsonPropertyAttribute("dataDiskSizeGb")]
public virtual System.Nullable DataDiskSizeGb { get; set; }
///
/// Input only. The type of the data disk attached to this instance, defaults to standard persistent disk
/// (`PD_STANDARD`).
///
[Newtonsoft.Json.JsonPropertyAttribute("dataDiskType")]
public virtual string DataDiskType { get; set; }
/// Input only. Disk encryption method used on the boot and data disks, defaults to GMEK.
[Newtonsoft.Json.JsonPropertyAttribute("diskEncryption")]
public virtual string DiskEncryption { get; set; }
/// Output only. Attached disks to notebook instance.
[Newtonsoft.Json.JsonPropertyAttribute("disks")]
public virtual System.Collections.Generic.IList Disks { get; set; }
///
/// Whether the end user authorizes Google Cloud to install GPU driver on this instance. If this field is empty
/// or set to false, the GPU driver won't be installed. Only applicable to instances with GPUs.
///
[Newtonsoft.Json.JsonPropertyAttribute("installGpuDriver")]
public virtual System.Nullable InstallGpuDriver { get; set; }
/// Output only. Checks how feasible a migration from UmN to WbI is.
[Newtonsoft.Json.JsonPropertyAttribute("instanceMigrationEligibility")]
public virtual InstanceMigrationEligibility InstanceMigrationEligibility { get; set; }
///
/// Input only. The owner of this instance after creation. Format: `alias@example.com` Currently supports one
/// owner only. If not specified, all of the service account users of your VM instance's service account can use
/// the instance.
///
[Newtonsoft.Json.JsonPropertyAttribute("instanceOwners")]
public virtual System.Collections.Generic.IList InstanceOwners { get; set; }
///
/// Input only. The KMS key used to encrypt the disks, only applicable if disk_encryption is CMEK. Format:
/// `projects/{project_id}/locations/{location}/keyRings/{key_ring_id}/cryptoKeys/{key_id}` Learn more about
/// [using your own encryption keys](/kms/docs/quickstart).
///
[Newtonsoft.Json.JsonPropertyAttribute("kmsKey")]
public virtual string KmsKey { get; set; }
/// Labels to apply to this instance. These can be later modified by the setLabels method.
[Newtonsoft.Json.JsonPropertyAttribute("labels")]
public virtual System.Collections.Generic.IDictionary Labels { get; set; }
///
/// Required. The [Compute Engine machine type](https://cloud.google.com/compute/docs/machine-resource) of this
/// instance.
///
[Newtonsoft.Json.JsonPropertyAttribute("machineType")]
public virtual string MachineType { get; set; }
///
/// Custom metadata to apply to this instance. For example, to specify a Cloud Storage bucket for automatic
/// backup, you can use the `gcs-data-bucket` metadata tag. Format: `"--metadata=gcs-data-bucket=BUCKET"`.
///
[Newtonsoft.Json.JsonPropertyAttribute("metadata")]
public virtual System.Collections.Generic.IDictionary Metadata { get; set; }
///
/// Output only. Bool indicating whether this notebook has been migrated to a Workbench Instance
///
[Newtonsoft.Json.JsonPropertyAttribute("migrated")]
public virtual System.Nullable Migrated { get; set; }
///
/// Output only. The name of this notebook instance. Format:
/// `projects/{project_id}/locations/{location}/instances/{instance_id}`
///
[Newtonsoft.Json.JsonPropertyAttribute("name")]
public virtual string Name { get; set; }
///
/// The name of the VPC that this instance is in. Format: `projects/{project_id}/global/networks/{network_id}`
///
[Newtonsoft.Json.JsonPropertyAttribute("network")]
public virtual string Network { get; set; }
/// Optional. The type of vNIC to be used on this interface. This may be gVNIC or VirtioNet.
[Newtonsoft.Json.JsonPropertyAttribute("nicType")]
public virtual string NicType { get; set; }
/// If true, the notebook instance will not register with the proxy.
[Newtonsoft.Json.JsonPropertyAttribute("noProxyAccess")]
public virtual System.Nullable NoProxyAccess { get; set; }
/// If true, no external IP will be assigned to this instance.
[Newtonsoft.Json.JsonPropertyAttribute("noPublicIp")]
public virtual System.Nullable NoPublicIp { get; set; }
/// Input only. If true, the data disk will not be auto deleted when deleting the instance.
[Newtonsoft.Json.JsonPropertyAttribute("noRemoveDataDisk")]
public virtual System.Nullable NoRemoveDataDisk { get; set; }
///
/// Path to a Bash script that automatically runs after a notebook instance fully boots up. The path must be a
/// URL or Cloud Storage path (`gs://path-to-file/file-name`).
///
[Newtonsoft.Json.JsonPropertyAttribute("postStartupScript")]
public virtual string PostStartupScript { get; set; }
/// Output only. The proxy endpoint that is used to access the Jupyter notebook.
[Newtonsoft.Json.JsonPropertyAttribute("proxyUri")]
public virtual string ProxyUri { get; set; }
///
/// Optional. The optional reservation affinity. Setting this field will apply the specified [Zonal Compute
/// Reservation](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) to this notebook
/// instance.
///
[Newtonsoft.Json.JsonPropertyAttribute("reservationAffinity")]
public virtual ReservationAffinity ReservationAffinity { get; set; }
///
/// The service account on this instance, giving access to other Google Cloud services. You can use any service
/// account within the same project, but you must have the service account user permission to use the instance.
/// If not specified, the [Compute Engine default service
/// account](https://cloud.google.com/compute/docs/access/service-accounts#default_service_account) is used.
///
[Newtonsoft.Json.JsonPropertyAttribute("serviceAccount")]
public virtual string ServiceAccount { get; set; }
///
/// Optional. The URIs of service account scopes to be included in Compute Engine instances. If not specified,
/// the following [scopes](https://cloud.google.com/compute/docs/access/service-accounts#accesscopesiam) are
/// defined: - https://www.googleapis.com/auth/cloud-platform - https://www.googleapis.com/auth/userinfo.email
/// If not using default scopes, you need at least: https://www.googleapis.com/auth/compute
///
[Newtonsoft.Json.JsonPropertyAttribute("serviceAccountScopes")]
public virtual System.Collections.Generic.IList ServiceAccountScopes { get; set; }
///
/// Optional. Shielded VM configuration. [Images using supported Shielded VM
/// features](https://cloud.google.com/compute/docs/instances/modifying-shielded-vm).
///
[Newtonsoft.Json.JsonPropertyAttribute("shieldedInstanceConfig")]
public virtual ShieldedInstanceConfig ShieldedInstanceConfig { get; set; }
/// Output only. The state of this instance.
[Newtonsoft.Json.JsonPropertyAttribute("state")]
public virtual string State { get; set; }
///
/// The name of the subnet that this instance is in. Format:
/// `projects/{project_id}/regions/{region}/subnetworks/{subnetwork_id}`
///
[Newtonsoft.Json.JsonPropertyAttribute("subnet")]
public virtual string Subnet { get; set; }
///
/// Optional. The Compute Engine network tags to add to runtime (see [Add network
/// tags](https://cloud.google.com/vpc/docs/add-remove-network-tags)).
///
[Newtonsoft.Json.JsonPropertyAttribute("tags")]
public virtual System.Collections.Generic.IList Tags { get; set; }
private string _updateTimeRaw;
private object _updateTime;
/// Output only. Instance update time.
[Newtonsoft.Json.JsonPropertyAttribute("updateTime")]
public virtual string UpdateTimeRaw
{
get => _updateTimeRaw;
set
{
_updateTime = Google.Apis.Util.Utilities.DeserializeForGoogleFormat(value);
_updateTimeRaw = value;
}
}
/// representation of .
[Newtonsoft.Json.JsonIgnoreAttribute]
[System.ObsoleteAttribute("This property is obsolete and may behave unexpectedly; please use UpdateTimeDateTimeOffset instead.")]
public virtual object UpdateTime
{
get => _updateTime;
set
{
_updateTimeRaw = Google.Apis.Util.Utilities.SerializeForGoogleFormat(value);
_updateTime = value;
}
}
/// representation of .
[Newtonsoft.Json.JsonIgnoreAttribute]
public virtual System.DateTimeOffset? UpdateTimeDateTimeOffset
{
get => Google.Apis.Util.DiscoveryFormat.ParseGoogleDateTimeToDateTimeOffset(UpdateTimeRaw);
set => UpdateTimeRaw = Google.Apis.Util.DiscoveryFormat.FormatDateTimeOffsetToGoogleDateTime(value);
}
/// The upgrade history of this instance.
[Newtonsoft.Json.JsonPropertyAttribute("upgradeHistory")]
public virtual System.Collections.Generic.IList UpgradeHistory { get; set; }
/// Use a Compute Engine VM image to start the notebook instance.
[Newtonsoft.Json.JsonPropertyAttribute("vmImage")]
public virtual VmImage VmImage { get; set; }
/// The ETag of the item.
public virtual string ETag { get; set; }
}
/// Notebook instance configurations that can be updated.
public class InstanceConfig : Google.Apis.Requests.IDirectResponseSchema
{
/// Verifies core internal services are running.
[Newtonsoft.Json.JsonPropertyAttribute("enableHealthMonitoring")]
public virtual System.Nullable EnableHealthMonitoring { get; set; }
///
/// Cron expression in UTC timezone, used to schedule instance auto upgrade. Please follow the [cron
/// format](https://en.wikipedia.org/wiki/Cron).
///
[Newtonsoft.Json.JsonPropertyAttribute("notebookUpgradeSchedule")]
public virtual string NotebookUpgradeSchedule { get; set; }
/// The ETag of the item.
public virtual string ETag { get; set; }
}
///
/// InstanceMigrationEligibility represents the feasibility information of a migration from UmN to WbI.
///
public class InstanceMigrationEligibility : Google.Apis.Requests.IDirectResponseSchema
{
///
/// Output only. Certain configurations make the UmN ineligible for an automatic migration. A manual migration
/// is required.
///
[Newtonsoft.Json.JsonPropertyAttribute("errors")]
public virtual System.Collections.Generic.IList Errors { get; set; }
/// Output only. Certain configurations will be defaulted during the migration.
[Newtonsoft.Json.JsonPropertyAttribute("warnings")]
public virtual System.Collections.Generic.IList Warnings { get; set; }
/// The ETag of the item.
public virtual string ETag { get; set; }
}
/// Response for checking if a notebook instance is upgradeable.
public class IsInstanceUpgradeableResponse : Google.Apis.Requests.IDirectResponseSchema
{
///
/// The new image self link this instance will be upgraded to if calling the upgrade endpoint. This field will
/// only be populated if field upgradeable is true.
///
[Newtonsoft.Json.JsonPropertyAttribute("upgradeImage")]
public virtual string UpgradeImage { get; set; }
/// Additional information about upgrade.
[Newtonsoft.Json.JsonPropertyAttribute("upgradeInfo")]
public virtual string UpgradeInfo { get; set; }
///
/// The version this instance will be upgraded to if calling the upgrade endpoint. This field will only be
/// populated if field upgradeable is true.
///
[Newtonsoft.Json.JsonPropertyAttribute("upgradeVersion")]
public virtual string UpgradeVersion { get; set; }
/// If an instance is upgradeable.
[Newtonsoft.Json.JsonPropertyAttribute("upgradeable")]
public virtual System.Nullable Upgradeable { get; set; }
/// The ETag of the item.
public virtual string ETag { get; set; }
}
/// Response for listing environments.
public class ListEnvironmentsResponse : Google.Apis.Requests.IDirectResponseSchema
{
/// A list of returned environments.
[Newtonsoft.Json.JsonPropertyAttribute("environments")]
public virtual System.Collections.Generic.IList Environments { get; set; }
///
/// A page token that can be used to continue listing from the last result in the next list call.
///
[Newtonsoft.Json.JsonPropertyAttribute("nextPageToken")]
public virtual string NextPageToken { get; set; }
/// Locations that could not be reached.
[Newtonsoft.Json.JsonPropertyAttribute("unreachable")]
public virtual System.Collections.Generic.IList Unreachable { get; set; }
/// The ETag of the item.
public virtual string ETag { get; set; }
}
/// Response for listing scheduled notebook executions
public class ListExecutionsResponse : Google.Apis.Requests.IDirectResponseSchema
{
/// A list of returned instances.
[Newtonsoft.Json.JsonPropertyAttribute("executions")]
public virtual System.Collections.Generic.IList Executions { get; set; }
///
/// Page token that can be used to continue listing from the last result in the next list call.
///
[Newtonsoft.Json.JsonPropertyAttribute("nextPageToken")]
public virtual string NextPageToken { get; set; }
///
/// Executions IDs that could not be reached. For example:
/// ['projects/{project_id}/location/{location}/executions/imagenet_test1',
/// 'projects/{project_id}/location/{location}/executions/classifier_train1']
///
[Newtonsoft.Json.JsonPropertyAttribute("unreachable")]
public virtual System.Collections.Generic.IList Unreachable { get; set; }
/// The ETag of the item.
public virtual string ETag { get; set; }
}
/// Response for listing notebook instances.
public class ListInstancesResponse : Google.Apis.Requests.IDirectResponseSchema
{
/// A list of returned instances.
[Newtonsoft.Json.JsonPropertyAttribute("instances")]
public virtual System.Collections.Generic.IList Instances { get; set; }
///
/// Page token that can be used to continue listing from the last result in the next list call.
///
[Newtonsoft.Json.JsonPropertyAttribute("nextPageToken")]
public virtual string NextPageToken { get; set; }
///
/// Locations that could not be reached. For example, `['us-west1-a', 'us-central1-b']`. A ListInstancesResponse
/// will only contain either instances or unreachables,
///
[Newtonsoft.Json.JsonPropertyAttribute("unreachable")]
public virtual System.Collections.Generic.IList Unreachable { get; set; }
/// The ETag of the item.
public virtual string ETag { get; set; }
}
/// The response message for Locations.ListLocations.
public class ListLocationsResponse : Google.Apis.Requests.IDirectResponseSchema
{
/// A list of locations that matches the specified filter in the request.
[Newtonsoft.Json.JsonPropertyAttribute("locations")]
public virtual System.Collections.Generic.IList Locations { get; set; }
/// The standard List next-page token.
[Newtonsoft.Json.JsonPropertyAttribute("nextPageToken")]
public virtual string NextPageToken { get; set; }
/// The ETag of the item.
public virtual string ETag { get; set; }
}
/// The response message for Operations.ListOperations.
public class ListOperationsResponse : Google.Apis.Requests.IDirectResponseSchema
{
/// The standard List next-page token.
[Newtonsoft.Json.JsonPropertyAttribute("nextPageToken")]
public virtual string NextPageToken { get; set; }
/// A list of operations that matches the specified filter in the request.
[Newtonsoft.Json.JsonPropertyAttribute("operations")]
public virtual System.Collections.Generic.IList Operations { get; set; }
///
/// Unordered list. Unreachable resources. Populated when the request sets
/// `ListOperationsRequest.return_partial_success` and reads across collections. For example, when attempting to
/// list all resources across all supported locations.
///
[Newtonsoft.Json.JsonPropertyAttribute("unreachable")]
public virtual System.Collections.Generic.IList Unreachable { get; set; }
/// The ETag of the item.
public virtual string ETag { get; set; }
}
/// Response for listing Managed Notebook Runtimes.
public class ListRuntimesResponse : Google.Apis.Requests.IDirectResponseSchema
{
///
/// Page token that can be used to continue listing from the last result in the next list call.
///
[Newtonsoft.Json.JsonPropertyAttribute("nextPageToken")]
public virtual string NextPageToken { get; set; }
/// A list of returned Runtimes.
[Newtonsoft.Json.JsonPropertyAttribute("runtimes")]
public virtual System.Collections.Generic.IList Runtimes { get; set; }
///
/// Locations that could not be reached. For example, `['us-west1', 'us-central1']`. A ListRuntimesResponse will
/// only contain either runtimes or unreachables,
///
[Newtonsoft.Json.JsonPropertyAttribute("unreachable")]
public virtual System.Collections.Generic.IList Unreachable { get; set; }
/// The ETag of the item.
public virtual string ETag { get; set; }
}
/// Response for listing scheduled notebook job.
public class ListSchedulesResponse : Google.Apis.Requests.IDirectResponseSchema
{
///
/// Page token that can be used to continue listing from the last result in the next list call.
///
[Newtonsoft.Json.JsonPropertyAttribute("nextPageToken")]
public virtual string NextPageToken { get; set; }
/// A list of returned instances.
[Newtonsoft.Json.JsonPropertyAttribute("schedules")]
public virtual System.Collections.Generic.IList Schedules { get; set; }
///
/// Schedules that could not be reached. For example:
/// ['projects/{project_id}/location/{location}/schedules/monthly_digest',
/// 'projects/{project_id}/location/{location}/schedules/weekly_sentiment']
///
[Newtonsoft.Json.JsonPropertyAttribute("unreachable")]
public virtual System.Collections.Generic.IList Unreachable { get; set; }
/// The ETag of the item.
public virtual string ETag { get; set; }
}
/// A Local attached disk resource.
public class LocalDisk : Google.Apis.Requests.IDirectResponseSchema
{
///
/// Optional. Output only. Specifies whether the disk will be auto-deleted when the instance is deleted (but not
/// when the disk is detached from the instance).
///
[Newtonsoft.Json.JsonPropertyAttribute("autoDelete")]
public virtual System.Nullable AutoDelete { get; set; }
///
/// Optional. Output only. Indicates that this is a boot disk. The virtual machine will use the first partition
/// of the disk for its root filesystem.
///
[Newtonsoft.Json.JsonPropertyAttribute("boot")]
public virtual System.Nullable Boot { get; set; }
///
/// Optional. Output only. Specifies a unique device name of your choice that is reflected into the
/// `/dev/disk/by-id/google-*` tree of a Linux operating system running within the instance. This name can be
/// used to reference the device for mounting, resizing, and so on, from within the instance. If not specified,
/// the server chooses a default device name to apply to this disk, in the form persistent-disk-x, where x is a
/// number assigned by Google Compute Engine. This field is only applicable for persistent disks.
///
[Newtonsoft.Json.JsonPropertyAttribute("deviceName")]
public virtual string DeviceName { get; set; }
///
/// Output only. Indicates a list of features to enable on the guest operating system. Applicable only for
/// bootable images. Read Enabling guest operating system features to see a list of available options.
///
[Newtonsoft.Json.JsonPropertyAttribute("guestOsFeatures")]
public virtual System.Collections.Generic.IList GuestOsFeatures { get; set; }
///
/// Output only. A zero-based index to this disk, where 0 is reserved for the boot disk. If you have many disks
/// attached to an instance, each disk would have a unique index number.
///
[Newtonsoft.Json.JsonPropertyAttribute("index")]
public virtual System.Nullable Index { get; set; }
///
/// Input only. Specifies the parameters for a new disk that will be created alongside the new instance. Use
/// initialization parameters to create boot disks or local SSDs attached to the new instance. This property is
/// mutually exclusive with the source property; you can only define one or the other, but not both.
///
[Newtonsoft.Json.JsonPropertyAttribute("initializeParams")]
public virtual LocalDiskInitializeParams InitializeParams { get; set; }
///
/// Specifies the disk interface to use for attaching this disk, which is either SCSI or NVME. The default is
/// SCSI. Persistent disks must always use SCSI and the request will fail if you attempt to attach a persistent
/// disk in any other format than SCSI. Local SSDs can use either NVME or SCSI. For performance characteristics
/// of SCSI over NVMe, see Local SSD performance. Valid values: * `NVME` * `SCSI`
///
[Newtonsoft.Json.JsonPropertyAttribute("interface")]
public virtual string Interface__ { get; set; }
/// Output only. Type of the resource. Always compute#attachedDisk for attached disks.
[Newtonsoft.Json.JsonPropertyAttribute("kind")]
public virtual string Kind { get; set; }
/// Output only. Any valid publicly visible licenses.
[Newtonsoft.Json.JsonPropertyAttribute("licenses")]
public virtual System.Collections.Generic.IList Licenses { get; set; }
///
/// The mode in which to attach this disk, either `READ_WRITE` or `READ_ONLY`. If not specified, the default is
/// to attach the disk in `READ_WRITE` mode. Valid values: * `READ_ONLY` * `READ_WRITE`
///
[Newtonsoft.Json.JsonPropertyAttribute("mode")]
public virtual string Mode { get; set; }
/// Specifies a valid partial or full URL to an existing Persistent Disk resource.
[Newtonsoft.Json.JsonPropertyAttribute("source")]
public virtual string Source { get; set; }
///
/// Specifies the type of the disk, either `SCRATCH` or `PERSISTENT`. If not specified, the default is
/// `PERSISTENT`. Valid values: * `PERSISTENT` * `SCRATCH`
///
[Newtonsoft.Json.JsonPropertyAttribute("type")]
public virtual string Type { get; set; }
/// The ETag of the item.
public virtual string ETag { get; set; }
}
///
/// Input only. Specifies the parameters for a new disk that will be created alongside the new instance. Use
/// initialization parameters to create boot disks or local SSDs attached to the new runtime. This property is
/// mutually exclusive with the source property; you can only define one or the other, but not both.
///
public class LocalDiskInitializeParams : Google.Apis.Requests.IDirectResponseSchema
{
/// Optional. Provide this property when creating the disk.
[Newtonsoft.Json.JsonPropertyAttribute("description")]
public virtual string Description { get; set; }
///
/// Optional. Specifies the disk name. If not specified, the default is to use the name of the instance. If the
/// disk with the instance name exists already in the given zone/region, a new name will be automatically
/// generated.
///
[Newtonsoft.Json.JsonPropertyAttribute("diskName")]
public virtual string DiskName { get; set; }
///
/// Optional. Specifies the size of the disk in base-2 GB. If not specified, the disk will be the same size as
/// the image (usually 10GB). If specified, the size must be equal to or larger than 10GB. Default 100 GB.
///
[Newtonsoft.Json.JsonPropertyAttribute("diskSizeGb")]
public virtual System.Nullable DiskSizeGb { get; set; }
///
/// Input only. The type of the boot disk attached to this instance, defaults to standard persistent disk
/// (`PD_STANDARD`).
///
[Newtonsoft.Json.JsonPropertyAttribute("diskType")]
public virtual string DiskType { get; set; }
///
/// Optional. Labels to apply to this disk. These can be later modified by the disks.setLabels method. This
/// field is only applicable for persistent disks.
///
[Newtonsoft.Json.JsonPropertyAttribute("labels")]
public virtual System.Collections.Generic.IDictionary Labels { get; set; }
/// The ETag of the item.
public virtual string ETag { get; set; }
}
/// A resource that represents a Google Cloud location.
public class Location : Google.Apis.Requests.IDirectResponseSchema
{
/// The friendly name for this location, typically a nearby city name. For example, "Tokyo".
[Newtonsoft.Json.JsonPropertyAttribute("displayName")]
public virtual string DisplayName { get; set; }
///
/// Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"}
///
[Newtonsoft.Json.JsonPropertyAttribute("labels")]
public virtual System.Collections.Generic.IDictionary Labels { get; set; }
/// The canonical id for this location. For example: `"us-east1"`.
[Newtonsoft.Json.JsonPropertyAttribute("locationId")]
public virtual string LocationId { get; set; }
/// Service-specific metadata. For example the available capacity at the given location.
[Newtonsoft.Json.JsonPropertyAttribute("metadata")]
public virtual System.Collections.Generic.IDictionary Metadata { get; set; }
///
/// Resource name for the location, which may vary between implementations. For example:
/// `"projects/example-project/locations/us-east1"`
///
[Newtonsoft.Json.JsonPropertyAttribute("name")]
public virtual string Name { get; set; }
/// The ETag of the item.
public virtual string ETag { get; set; }
}
/// Request for migrating a User-Managed Notebook to Workbench Instances.
public class MigrateInstanceRequest : Google.Apis.Requests.IDirectResponseSchema
{
/// Optional. Specifies the behavior of post startup script during migration.
[Newtonsoft.Json.JsonPropertyAttribute("postStartupScriptOption")]
public virtual string PostStartupScriptOption { get; set; }
/// The ETag of the item.
public virtual string ETag { get; set; }
}
/// Request for migrating a Runtime to a Workbench Instance.
public class MigrateRuntimeRequest : Google.Apis.Requests.IDirectResponseSchema
{
///
/// Optional. Name of the VPC that the new Instance is in. This is required if the Runtime uses google-managed
/// network. If the Runtime uses customer-owned network, it will reuse the same VPC, and this field must be
/// empty. Format: `projects/{project_id}/global/networks/{network_id}`
///
[Newtonsoft.Json.JsonPropertyAttribute("network")]
public virtual string Network { get; set; }
/// Optional. Specifies the behavior of post startup script during migration.
[Newtonsoft.Json.JsonPropertyAttribute("postStartupScriptOption")]
public virtual string PostStartupScriptOption { get; set; }
/// Optional. Idempotent request UUID.
[Newtonsoft.Json.JsonPropertyAttribute("requestId")]
public virtual string RequestId { get; set; }
///
/// Optional. The service account to be included in the Compute Engine instance of the new Workbench Instance
/// when the Runtime uses "single user only" mode for permission. If not specified, the [Compute Engine default
/// service account](https://cloud.google.com/compute/docs/access/service-accounts#default_service_account) is
/// used. When the Runtime uses service account mode for permission, it will reuse the same service account, and
/// this field must be empty.
///
[Newtonsoft.Json.JsonPropertyAttribute("serviceAccount")]
public virtual string ServiceAccount { get; set; }
///
/// Optional. Name of the subnet that the new Instance is in. This is required if the Runtime uses
/// google-managed network. If the Runtime uses customer-owned network, it will reuse the same subnet, and this
/// field must be empty. Format: `projects/{project_id}/regions/{region}/subnetworks/{subnetwork_id}`
///
[Newtonsoft.Json.JsonPropertyAttribute("subnet")]
public virtual string Subnet { get; set; }
/// The ETag of the item.
public virtual string ETag { get; set; }
}
/// This resource represents a long-running operation that is the result of a network API call.
public class Operation : Google.Apis.Requests.IDirectResponseSchema
{
///
/// If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed,
/// and either `error` or `response` is available.
///
[Newtonsoft.Json.JsonPropertyAttribute("done")]
public virtual System.Nullable Done { get; set; }
/// The error result of the operation in case of failure or cancellation.
[Newtonsoft.Json.JsonPropertyAttribute("error")]
public virtual Status Error { get; set; }
///
/// Service-specific metadata associated with the operation. It typically contains progress information and
/// common metadata such as create time. Some services might not provide such metadata. Any method that returns
/// a long-running operation should document the metadata type, if any.
///
[Newtonsoft.Json.JsonPropertyAttribute("metadata")]
public virtual System.Collections.Generic.IDictionary Metadata { get; set; }
///
/// The server-assigned name, which is only unique within the same service that originally returns it. If you
/// use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
///
[Newtonsoft.Json.JsonPropertyAttribute("name")]
public virtual string Name { get; set; }
///
/// The normal, successful response of the operation. If the original method returns no data on success, such as
/// `Delete`, the response is `google.protobuf.Empty`. If the original method is standard
/// `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have
/// the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is
/// `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
///
[Newtonsoft.Json.JsonPropertyAttribute("response")]
public virtual System.Collections.Generic.IDictionary Response { get; set; }
/// The ETag of the item.
public virtual string ETag { get; set; }
}
/// Represents the metadata of the long-running operation.
public class OperationMetadata : Google.Apis.Requests.IDirectResponseSchema
{
/// API version used to start the operation.
[Newtonsoft.Json.JsonPropertyAttribute("apiVersion")]
public virtual string ApiVersion { get; set; }
private string _createTimeRaw;
private object _createTime;
/// The time the operation was created.
[Newtonsoft.Json.JsonPropertyAttribute("createTime")]
public virtual string CreateTimeRaw
{
get => _createTimeRaw;
set
{
_createTime = Google.Apis.Util.Utilities.DeserializeForGoogleFormat(value);
_createTimeRaw = value;
}
}
/// representation of .
[Newtonsoft.Json.JsonIgnoreAttribute]
[System.ObsoleteAttribute("This property is obsolete and may behave unexpectedly; please use CreateTimeDateTimeOffset instead.")]
public virtual object CreateTime
{
get => _createTime;
set
{
_createTimeRaw = Google.Apis.Util.Utilities.SerializeForGoogleFormat(value);
_createTime = value;
}
}
/// representation of .
[Newtonsoft.Json.JsonIgnoreAttribute]
public virtual System.DateTimeOffset? CreateTimeDateTimeOffset
{
get => Google.Apis.Util.DiscoveryFormat.ParseGoogleDateTimeToDateTimeOffset(CreateTimeRaw);
set => CreateTimeRaw = Google.Apis.Util.DiscoveryFormat.FormatDateTimeOffsetToGoogleDateTime(value);
}
private string _endTimeRaw;
private object _endTime;
/// The time the operation finished running.
[Newtonsoft.Json.JsonPropertyAttribute("endTime")]
public virtual string EndTimeRaw
{
get => _endTimeRaw;
set
{
_endTime = Google.Apis.Util.Utilities.DeserializeForGoogleFormat(value);
_endTimeRaw = value;
}
}
/// representation of .
[Newtonsoft.Json.JsonIgnoreAttribute]
[System.ObsoleteAttribute("This property is obsolete and may behave unexpectedly; please use EndTimeDateTimeOffset instead.")]
public virtual object EndTime
{
get => _endTime;
set
{
_endTimeRaw = Google.Apis.Util.Utilities.SerializeForGoogleFormat(value);
_endTime = value;
}
}
/// representation of .
[Newtonsoft.Json.JsonIgnoreAttribute]
public virtual System.DateTimeOffset? EndTimeDateTimeOffset
{
get => Google.Apis.Util.DiscoveryFormat.ParseGoogleDateTimeToDateTimeOffset(EndTimeRaw);
set => EndTimeRaw = Google.Apis.Util.DiscoveryFormat.FormatDateTimeOffsetToGoogleDateTime(value);
}
/// API endpoint name of this operation.
[Newtonsoft.Json.JsonPropertyAttribute("endpoint")]
public virtual string Endpoint { get; set; }
///
/// Identifies whether the user has requested cancellation of the operation. Operations that have successfully
/// been cancelled have google.longrunning.Operation.error value with a google.rpc.Status.code of `1`,
/// corresponding to `Code.CANCELLED`.
///
[Newtonsoft.Json.JsonPropertyAttribute("requestedCancellation")]
public virtual System.Nullable RequestedCancellation { get; set; }
/// Human-readable status of the operation, if any.
[Newtonsoft.Json.JsonPropertyAttribute("statusMessage")]
public virtual string StatusMessage { get; set; }
/// Server-defined resource path for the target of the operation.
[Newtonsoft.Json.JsonPropertyAttribute("target")]
public virtual string Target { get; set; }
/// Name of the verb executed by the operation.
[Newtonsoft.Json.JsonPropertyAttribute("verb")]
public virtual string Verb { get; set; }
/// The ETag of the item.
public virtual string ETag { get; set; }
}
///
/// An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A
/// `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single
/// `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A
/// `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role.
/// For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical
/// expression that allows access to a resource only if the expression evaluates to `true`. A condition can add
/// constraints based on attributes of the request, the resource, or both. To learn which resources support
/// conditions in their IAM policies, see the [IAM
/// documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:**
/// ```
/// {
/// "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com",
/// "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] },
/// { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": {
/// "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time
/// < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 }
/// ```
/// **YAML
/// example:**
/// ```
/// bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com -
/// serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin -
/// members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable
/// access description: Does not grant access after Sep 2020 expression: request.time <
/// timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3
/// ```
/// For a description of IAM and its
/// features, see the [IAM documentation](https://cloud.google.com/iam/docs/).
///
public class Policy : Google.Apis.Requests.IDirectResponseSchema
{
///
/// Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that
/// determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one
/// principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals
/// can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the
/// `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you
/// can add another 1,450 principals to the `bindings` in the `Policy`.
///
[Newtonsoft.Json.JsonPropertyAttribute("bindings")]
public virtual System.Collections.Generic.IList Bindings { get; set; }
///
/// `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy
/// from overwriting each other. It is strongly suggested that systems make use of the `etag` in the
/// read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned
/// in the response to `getIamPolicy`, and systems are expected to put that etag in the request to
/// `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:**
/// If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit
/// this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the
/// conditions in the version `3` policy are lost.
///
[Newtonsoft.Json.JsonPropertyAttribute("etag")]
public virtual string ETag { get; set; }
///
/// Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid
/// value are rejected. Any operation that affects conditional role bindings must specify version `3`. This
/// requirement applies to the following operations: * Getting a policy that includes a conditional role binding
/// * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing
/// any role binding, with or without a condition, from a policy that includes conditions **Important:** If you
/// use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this
/// field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the
/// conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on
/// that policy may specify any valid version or leave the field unset. To learn which resources support
/// conditions in their IAM policies, see the [IAM
/// documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
///
[Newtonsoft.Json.JsonPropertyAttribute("version")]
public virtual System.Nullable Version { get; set; }
}
/// Request for getting a new access token.
public class RefreshRuntimeTokenInternalRequest : Google.Apis.Requests.IDirectResponseSchema
{
///
/// Required. The VM hardware token for authenticating the VM.
/// https://cloud.google.com/compute/docs/instances/verifying-instance-identity
///
[Newtonsoft.Json.JsonPropertyAttribute("vmId")]
public virtual string VmId { get; set; }
/// The ETag of the item.
public virtual string ETag { get; set; }
}
/// Response with a new access token.
public class RefreshRuntimeTokenInternalResponse : Google.Apis.Requests.IDirectResponseSchema
{
/// The OAuth 2.0 access token.
[Newtonsoft.Json.JsonPropertyAttribute("accessToken")]
public virtual string AccessToken { get; set; }
private string _expireTimeRaw;
private object _expireTime;
/// Output only. Token expiration time.
[Newtonsoft.Json.JsonPropertyAttribute("expireTime")]
public virtual string ExpireTimeRaw
{
get => _expireTimeRaw;
set
{
_expireTime = Google.Apis.Util.Utilities.DeserializeForGoogleFormat(value);
_expireTimeRaw = value;
}
}
/// representation of .
[Newtonsoft.Json.JsonIgnoreAttribute]
[System.ObsoleteAttribute("This property is obsolete and may behave unexpectedly; please use ExpireTimeDateTimeOffset instead.")]
public virtual object ExpireTime
{
get => _expireTime;
set
{
_expireTimeRaw = Google.Apis.Util.Utilities.SerializeForGoogleFormat(value);
_expireTime = value;
}
}
/// representation of .
[Newtonsoft.Json.JsonIgnoreAttribute]
public virtual System.DateTimeOffset? ExpireTimeDateTimeOffset
{
get => Google.Apis.Util.DiscoveryFormat.ParseGoogleDateTimeToDateTimeOffset(ExpireTimeRaw);
set => ExpireTimeRaw = Google.Apis.Util.DiscoveryFormat.FormatDateTimeOffsetToGoogleDateTime(value);
}
/// The ETag of the item.
public virtual string ETag { get; set; }
}
/// Request for registering a notebook instance.
public class RegisterInstanceRequest : Google.Apis.Requests.IDirectResponseSchema
{
///
/// Required. User defined unique ID of this instance. The `instance_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.
///
[Newtonsoft.Json.JsonPropertyAttribute("instanceId")]
public virtual string InstanceId { get; set; }
/// The ETag of the item.
public virtual string ETag { get; set; }
}
/// Request for reporting a Managed Notebook Event.
public class ReportInstanceEventRequest : Google.Apis.Requests.IDirectResponseSchema
{
/// Required. The Event to be reported.
[Newtonsoft.Json.JsonPropertyAttribute("event")]
public virtual Event Event__ { get; set; }
///
/// Required. The VM hardware token for authenticating the VM.
/// https://cloud.google.com/compute/docs/instances/verifying-instance-identity
///
[Newtonsoft.Json.JsonPropertyAttribute("vmId")]
public virtual string VmId { get; set; }
/// The ETag of the item.
public virtual string ETag { get; set; }
}
/// Request for notebook instances to report information to Notebooks API.
public class ReportInstanceInfoRequest : Google.Apis.Requests.IDirectResponseSchema
{
///
/// The metadata reported to Notebooks API. This will be merged to the instance metadata store
///
[Newtonsoft.Json.JsonPropertyAttribute("metadata")]
public virtual System.Collections.Generic.IDictionary Metadata { get; set; }
///
/// Required. The VM hardware token for authenticating the VM.
/// https://cloud.google.com/compute/docs/instances/verifying-instance-identity
///
[Newtonsoft.Json.JsonPropertyAttribute("vmId")]
public virtual string VmId { get; set; }
/// The ETag of the item.
public virtual string ETag { get; set; }
}
/// Request for reporting a Managed Notebook Event.
public class ReportRuntimeEventRequest : Google.Apis.Requests.IDirectResponseSchema
{
/// Required. The Event to be reported.
[Newtonsoft.Json.JsonPropertyAttribute("event")]
public virtual Event Event__ { get; set; }
///
/// Required. The VM hardware token for authenticating the VM.
/// https://cloud.google.com/compute/docs/instances/verifying-instance-identity
///
[Newtonsoft.Json.JsonPropertyAttribute("vmId")]
public virtual string VmId { get; set; }
/// The ETag of the item.
public virtual string ETag { get; set; }
}
/// Reservation Affinity for consuming Zonal reservation.
public class ReservationAffinity : Google.Apis.Requests.IDirectResponseSchema
{
/// Optional. Type of reservation to consume
[Newtonsoft.Json.JsonPropertyAttribute("consumeReservationType")]
public virtual string ConsumeReservationType { get; set; }
/// Optional. Corresponds to the label key of reservation resource.
[Newtonsoft.Json.JsonPropertyAttribute("key")]
public virtual string Key { get; set; }
/// Optional. Corresponds to the label values of reservation resource.
[Newtonsoft.Json.JsonPropertyAttribute("values")]
public virtual System.Collections.Generic.IList Values { get; set; }
/// The ETag of the item.
public virtual string ETag { get; set; }
}
/// Request for resetting a notebook instance
public class ResetInstanceRequest : Google.Apis.Requests.IDirectResponseSchema
{
/// The ETag of the item.
public virtual string ETag { get; set; }
}
/// Request for resetting a Managed Notebook Runtime.
public class ResetRuntimeRequest : Google.Apis.Requests.IDirectResponseSchema
{
/// Idempotent request UUID.
[Newtonsoft.Json.JsonPropertyAttribute("requestId")]
public virtual string RequestId { get; set; }
/// The ETag of the item.
public virtual string ETag { get; set; }
}
/// Request for rollbacking a notebook instance
public class RollbackInstanceRequest : Google.Apis.Requests.IDirectResponseSchema
{
///
/// Required. The snapshot for rollback. Example: `projects/test-project/global/snapshots/krwlzipynril`.
///
[Newtonsoft.Json.JsonPropertyAttribute("targetSnapshot")]
public virtual string TargetSnapshot { get; set; }
/// The ETag of the item.
public virtual string ETag { get; set; }
}
/// The definition of a Runtime for a managed notebook instance.
public class Runtime : Google.Apis.Requests.IDirectResponseSchema
{
/// The config settings for accessing runtime.
[Newtonsoft.Json.JsonPropertyAttribute("accessConfig")]
public virtual RuntimeAccessConfig AccessConfig { get; set; }
private string _createTimeRaw;
private object _createTime;
/// Output only. Runtime creation time.
[Newtonsoft.Json.JsonPropertyAttribute("createTime")]
public virtual string CreateTimeRaw
{
get => _createTimeRaw;
set
{
_createTime = Google.Apis.Util.Utilities.DeserializeForGoogleFormat(value);
_createTimeRaw = value;
}
}
/// representation of .
[Newtonsoft.Json.JsonIgnoreAttribute]
[System.ObsoleteAttribute("This property is obsolete and may behave unexpectedly; please use CreateTimeDateTimeOffset instead.")]
public virtual object CreateTime
{
get => _createTime;
set
{
_createTimeRaw = Google.Apis.Util.Utilities.SerializeForGoogleFormat(value);
_createTime = value;
}
}
/// representation of .
[Newtonsoft.Json.JsonIgnoreAttribute]
public virtual System.DateTimeOffset? CreateTimeDateTimeOffset
{
get => Google.Apis.Util.DiscoveryFormat.ParseGoogleDateTimeToDateTimeOffset(CreateTimeRaw);
set => CreateTimeRaw = Google.Apis.Util.DiscoveryFormat.FormatDateTimeOffsetToGoogleDateTime(value);
}
/// Output only. Runtime health_state.
[Newtonsoft.Json.JsonPropertyAttribute("healthState")]
public virtual string HealthState { get; set; }
///
/// Optional. The labels to associate with this Managed Notebook or Runtime. Label **keys** must contain 1 to 63
/// characters, and must conform to [RFC 1035](https://www.ietf.org/rfc/rfc1035.txt). Label **values** may be
/// empty, but, if present, must contain 1 to 63 characters, and must conform to [RFC
/// 1035](https://www.ietf.org/rfc/rfc1035.txt). No more than 32 labels can be associated with a cluster.
///
[Newtonsoft.Json.JsonPropertyAttribute("labels")]
public virtual System.Collections.Generic.IDictionary Labels { get; set; }
/// Output only. Contains Runtime daemon metrics such as Service status and JupyterLab stats.
[Newtonsoft.Json.JsonPropertyAttribute("metrics")]
public virtual RuntimeMetrics Metrics { get; set; }
///
/// Output only. Bool indicating whether this notebook has been migrated to a Workbench Instance
///
[Newtonsoft.Json.JsonPropertyAttribute("migrated")]
public virtual System.Nullable Migrated { get; set; }
///
/// Output only. The resource name of the runtime. Format:
/// `projects/{project}/locations/{location}/runtimes/{runtimeId}`
///
[Newtonsoft.Json.JsonPropertyAttribute("name")]
public virtual string Name { get; set; }
/// Output only. Checks how feasible a migration from GmN to WbI is.
[Newtonsoft.Json.JsonPropertyAttribute("runtimeMigrationEligibility")]
public virtual RuntimeMigrationEligibility RuntimeMigrationEligibility { get; set; }
/// The config settings for software inside the runtime.
[Newtonsoft.Json.JsonPropertyAttribute("softwareConfig")]
public virtual RuntimeSoftwareConfig SoftwareConfig { get; set; }
/// Output only. Runtime state.
[Newtonsoft.Json.JsonPropertyAttribute("state")]
public virtual string State { get; set; }
private string _updateTimeRaw;
private object _updateTime;
/// Output only. Runtime update time.
[Newtonsoft.Json.JsonPropertyAttribute("updateTime")]
public virtual string UpdateTimeRaw
{
get => _updateTimeRaw;
set
{
_updateTime = Google.Apis.Util.Utilities.DeserializeForGoogleFormat(value);
_updateTimeRaw = value;
}
}
/// representation of .
[Newtonsoft.Json.JsonIgnoreAttribute]
[System.ObsoleteAttribute("This property is obsolete and may behave unexpectedly; please use UpdateTimeDateTimeOffset instead.")]
public virtual object UpdateTime
{
get => _updateTime;
set
{
_updateTimeRaw = Google.Apis.Util.Utilities.SerializeForGoogleFormat(value);
_updateTime = value;
}
}
/// representation of .
[Newtonsoft.Json.JsonIgnoreAttribute]
public virtual System.DateTimeOffset? UpdateTimeDateTimeOffset
{
get => Google.Apis.Util.DiscoveryFormat.ParseGoogleDateTimeToDateTimeOffset(UpdateTimeRaw);
set => UpdateTimeRaw = Google.Apis.Util.DiscoveryFormat.FormatDateTimeOffsetToGoogleDateTime(value);
}
/// Use a Compute Engine VM image to start the managed notebook instance.
[Newtonsoft.Json.JsonPropertyAttribute("virtualMachine")]
public virtual VirtualMachine VirtualMachine { get; set; }
/// The ETag of the item.
public virtual string ETag { get; set; }
}
///
/// Definition of the types of hardware accelerators that can be used. See [Compute Engine
/// AcceleratorTypes](https://cloud.google.com/compute/docs/reference/beta/acceleratorTypes). Examples: *
/// `nvidia-tesla-k80` * `nvidia-tesla-p100` * `nvidia-tesla-v100` * `nvidia-tesla-p4` * `nvidia-tesla-t4` *
/// `nvidia-tesla-a100`
///
public class RuntimeAcceleratorConfig : Google.Apis.Requests.IDirectResponseSchema
{
/// Count of cores of this accelerator.
[Newtonsoft.Json.JsonPropertyAttribute("coreCount")]
public virtual System.Nullable CoreCount { get; set; }
/// Accelerator model.
[Newtonsoft.Json.JsonPropertyAttribute("type")]
public virtual string Type { get; set; }
/// The ETag of the item.
public virtual string ETag { get; set; }
}
/// Specifies the login configuration for Runtime
public class RuntimeAccessConfig : Google.Apis.Requests.IDirectResponseSchema
{
/// The type of access mode this instance.
[Newtonsoft.Json.JsonPropertyAttribute("accessType")]
public virtual string AccessType { get; set; }
/// Output only. The proxy endpoint that is used to access the runtime.
[Newtonsoft.Json.JsonPropertyAttribute("proxyUri")]
public virtual string ProxyUri { get; set; }
///
/// The owner of this runtime after creation. Format: `alias@example.com` Currently supports one owner only.
///
[Newtonsoft.Json.JsonPropertyAttribute("runtimeOwner")]
public virtual string RuntimeOwner { get; set; }
/// The ETag of the item.
public virtual string ETag { get; set; }
}
///
/// Optional. A list of features to enable on the guest operating system. Applicable only for bootable images. Read
/// [Enabling guest operating system
/// features](https://cloud.google.com/compute/docs/images/create-delete-deprecate-private-images#guest-os-features)
/// to see a list of available options. Guest OS features for boot disk.
///
public class RuntimeGuestOsFeature : Google.Apis.Requests.IDirectResponseSchema
{
///
/// The ID of a supported feature. Read [Enabling guest operating system
/// features](https://cloud.google.com/compute/docs/images/create-delete-deprecate-private-images#guest-os-features)
/// to see a list of available options. Valid values: * `FEATURE_TYPE_UNSPECIFIED` * `MULTI_IP_SUBNET` *
/// `SECURE_BOOT` * `UEFI_COMPATIBLE` * `VIRTIO_SCSI_MULTIQUEUE` * `WINDOWS`
///
[Newtonsoft.Json.JsonPropertyAttribute("type")]
public virtual string Type { get; set; }
/// The ETag of the item.
public virtual string ETag { get; set; }
}
/// Contains runtime daemon metrics, such as OS and kernels and sessions stats.
public class RuntimeMetrics : Google.Apis.Requests.IDirectResponseSchema
{
/// Output only. The system metrics.
[Newtonsoft.Json.JsonPropertyAttribute("systemMetrics")]
public virtual System.Collections.Generic.IDictionary SystemMetrics { get; set; }
/// The ETag of the item.
public virtual string ETag { get; set; }
}
///
/// RuntimeMigrationEligibility represents the feasibility information of a migration from GmN to WbI.
///
public class RuntimeMigrationEligibility : Google.Apis.Requests.IDirectResponseSchema
{
///
/// Output only. Certain configurations make the GmN ineligible for an automatic migration. A manual migration
/// is required.
///
[Newtonsoft.Json.JsonPropertyAttribute("errors")]
public virtual System.Collections.Generic.IList Errors { get; set; }
/// Output only. Certain configurations will be defaulted during the migration.
[Newtonsoft.Json.JsonPropertyAttribute("warnings")]
public virtual System.Collections.Generic.IList Warnings { get; set; }
/// The ETag of the item.
public virtual string ETag { get; set; }
}
///
/// A set of Shielded Instance options. See [Images using supported Shielded VM
/// features](https://cloud.google.com/compute/docs/instances/modifying-shielded-vm). Not all combinations are
/// valid.
///
public class RuntimeShieldedInstanceConfig : Google.Apis.Requests.IDirectResponseSchema
{
///
/// Defines whether the instance has integrity monitoring enabled. Enables monitoring and attestation of the
/// boot integrity of the instance. The attestation is performed against the integrity policy baseline. This
/// baseline is initially derived from the implicitly trusted boot image when the instance is created. Enabled
/// by default.
///
[Newtonsoft.Json.JsonPropertyAttribute("enableIntegrityMonitoring")]
public virtual System.Nullable EnableIntegrityMonitoring { get; set; }
///
/// Defines whether the instance has Secure Boot enabled. Secure Boot helps ensure that the system only runs
/// authentic software by verifying the digital signature of all boot components, and halting the boot process
/// if signature verification fails. Disabled by default.
///
[Newtonsoft.Json.JsonPropertyAttribute("enableSecureBoot")]
public virtual System.Nullable EnableSecureBoot { get; set; }
/// Defines whether the instance has the vTPM enabled. Enabled by default.
[Newtonsoft.Json.JsonPropertyAttribute("enableVtpm")]
public virtual System.Nullable EnableVtpm { get; set; }
/// The ETag of the item.
public virtual string ETag { get; set; }
}
///
/// Specifies the selection and configuration of software inside the runtime. The properties to set on runtime.
/// Properties keys are specified in `key:value` format, for example: * `idle_shutdown: true` *
/// `idle_shutdown_timeout: 180` * `enable_health_monitoring: true`
///
public class RuntimeSoftwareConfig : Google.Apis.Requests.IDirectResponseSchema
{
///
/// Specify a custom Cloud Storage path where the GPU driver is stored. If not specified, we'll automatically
/// choose from official GPU drivers.
///
[Newtonsoft.Json.JsonPropertyAttribute("customGpuDriverPath")]
public virtual string CustomGpuDriverPath { get; set; }
/// Bool indicating whether JupyterLab terminal will be available or not. Default: False
[Newtonsoft.Json.JsonPropertyAttribute("disableTerminal")]
public virtual System.Nullable DisableTerminal { get; set; }
/// Verifies core internal services are running. Default: True
[Newtonsoft.Json.JsonPropertyAttribute("enableHealthMonitoring")]
public virtual System.Nullable EnableHealthMonitoring { get; set; }
/// Runtime will automatically shutdown after idle_shutdown_time. Default: True
[Newtonsoft.Json.JsonPropertyAttribute("idleShutdown")]
public virtual System.Nullable IdleShutdown { get; set; }
/// Time in minutes to wait before shutting down runtime. Default: 180 minutes
[Newtonsoft.Json.JsonPropertyAttribute("idleShutdownTimeout")]
public virtual System.Nullable IdleShutdownTimeout { get; set; }
/// Install Nvidia Driver automatically. Default: True
[Newtonsoft.Json.JsonPropertyAttribute("installGpuDriver")]
public virtual System.Nullable InstallGpuDriver { get; set; }
/// Optional. Use a list of container images to use as Kernels in the notebook instance.
[Newtonsoft.Json.JsonPropertyAttribute("kernels")]
public virtual System.Collections.Generic.IList Kernels { get; set; }
/// Bool indicating whether mixer client should be disabled. Default: False
[Newtonsoft.Json.JsonPropertyAttribute("mixerDisabled")]
public virtual System.Nullable MixerDisabled { get; set; }
///
/// Cron expression in UTC timezone, used to schedule instance auto upgrade. Please follow the [cron
/// format](https://en.wikipedia.org/wiki/Cron).
///
[Newtonsoft.Json.JsonPropertyAttribute("notebookUpgradeSchedule")]
public virtual string NotebookUpgradeSchedule { get; set; }
///
/// Path to a Bash script that automatically runs after a notebook instance fully boots up. The path must be a
/// URL or Cloud Storage path (`gs://path-to-file/file-name`).
///
[Newtonsoft.Json.JsonPropertyAttribute("postStartupScript")]
public virtual string PostStartupScript { get; set; }
/// Behavior for the post startup script.
[Newtonsoft.Json.JsonPropertyAttribute("postStartupScriptBehavior")]
public virtual string PostStartupScriptBehavior { get; set; }
/// Output only. Bool indicating whether an newer image is available in an image family.
[Newtonsoft.Json.JsonPropertyAttribute("upgradeable")]
public virtual System.Nullable Upgradeable { get; set; }
/// Output only. version of boot image such as M100, from release label of the image.
[Newtonsoft.Json.JsonPropertyAttribute("version")]
public virtual string Version { get; set; }
/// The ETag of the item.
public virtual string ETag { get; set; }
}
/// The definition of a schedule.
public class Schedule : Google.Apis.Requests.IDirectResponseSchema
{
private string _createTimeRaw;
private object _createTime;
/// Output only. Time the schedule was created.
[Newtonsoft.Json.JsonPropertyAttribute("createTime")]
public virtual string CreateTimeRaw
{
get => _createTimeRaw;
set
{
_createTime = Google.Apis.Util.Utilities.DeserializeForGoogleFormat(value);
_createTimeRaw = value;
}
}
/// representation of .
[Newtonsoft.Json.JsonIgnoreAttribute]
[System.ObsoleteAttribute("This property is obsolete and may behave unexpectedly; please use CreateTimeDateTimeOffset instead.")]
public virtual object CreateTime
{
get => _createTime;
set
{
_createTimeRaw = Google.Apis.Util.Utilities.SerializeForGoogleFormat(value);
_createTime = value;
}
}
/// representation of .
[Newtonsoft.Json.JsonIgnoreAttribute]
public virtual System.DateTimeOffset? CreateTimeDateTimeOffset
{
get => Google.Apis.Util.DiscoveryFormat.ParseGoogleDateTimeToDateTimeOffset(CreateTimeRaw);
set => CreateTimeRaw = Google.Apis.Util.DiscoveryFormat.FormatDateTimeOffsetToGoogleDateTime(value);
}
///
/// Cron-tab formatted schedule by which the job will execute. Format: minute, hour, day of month, month, day of
/// week, e.g. `0 0 * * WED` = every Wednesday More examples: https://crontab.guru/examples.html
///
[Newtonsoft.Json.JsonPropertyAttribute("cronSchedule")]
public virtual string CronSchedule { get; set; }
/// A brief description of this environment.
[Newtonsoft.Json.JsonPropertyAttribute("description")]
public virtual string Description { get; set; }
///
/// Output only. Display name used for UI purposes. Name can only contain alphanumeric characters, hyphens `-`,
/// and underscores `_`.
///
[Newtonsoft.Json.JsonPropertyAttribute("displayName")]
public virtual string DisplayName { get; set; }
/// Notebook Execution Template corresponding to this schedule.
[Newtonsoft.Json.JsonPropertyAttribute("executionTemplate")]
public virtual ExecutionTemplate ExecutionTemplate { get; set; }
///
/// Output only. The name of this schedule. Format:
/// `projects/{project_id}/locations/{location}/schedules/{schedule_id}`
///
[Newtonsoft.Json.JsonPropertyAttribute("name")]
public virtual string Name { get; set; }
///
/// Output only. The most recent execution names triggered from this schedule and their corresponding states.
///
[Newtonsoft.Json.JsonPropertyAttribute("recentExecutions")]
public virtual System.Collections.Generic.IList RecentExecutions { get; set; }
[Newtonsoft.Json.JsonPropertyAttribute("state")]
public virtual string State { get; set; }
///
/// Timezone on which the cron_schedule. The value of this field must be a time zone name from the tz database.
/// TZ Database: https://en.wikipedia.org/wiki/List_of_tz_database_time_zones Note that some time zones include
/// a provision for daylight savings time. The rules for daylight saving time are determined by the chosen tz.
/// For UTC use the string "utc". If a time zone is not specified, the default will be in UTC (also known as
/// GMT).
///
[Newtonsoft.Json.JsonPropertyAttribute("timeZone")]
public virtual string TimeZone { get; set; }
private string _updateTimeRaw;
private object _updateTime;
/// Output only. Time the schedule was last updated.
[Newtonsoft.Json.JsonPropertyAttribute("updateTime")]
public virtual string UpdateTimeRaw
{
get => _updateTimeRaw;
set
{
_updateTime = Google.Apis.Util.Utilities.DeserializeForGoogleFormat(value);
_updateTimeRaw = value;
}
}
/// representation of .
[Newtonsoft.Json.JsonIgnoreAttribute]
[System.ObsoleteAttribute("This property is obsolete and may behave unexpectedly; please use UpdateTimeDateTimeOffset instead.")]
public virtual object UpdateTime
{
get => _updateTime;
set
{
_updateTimeRaw = Google.Apis.Util.Utilities.SerializeForGoogleFormat(value);
_updateTime = value;
}
}
/// representation of .
[Newtonsoft.Json.JsonIgnoreAttribute]
public virtual System.DateTimeOffset? UpdateTimeDateTimeOffset
{
get => Google.Apis.Util.DiscoveryFormat.ParseGoogleDateTimeToDateTimeOffset(UpdateTimeRaw);
set => UpdateTimeRaw = Google.Apis.Util.DiscoveryFormat.FormatDateTimeOffsetToGoogleDateTime(value);
}
/// The ETag of the item.
public virtual string ETag { get; set; }
}
///
/// Definition of a hardware accelerator. Note that not all combinations of `type` and `core_count` are valid. See
/// [GPUs on Compute Engine](https://cloud.google.com/compute/docs/gpus) to find a valid combination. TPUs are not
/// supported.
///
public class SchedulerAcceleratorConfig : Google.Apis.Requests.IDirectResponseSchema
{
/// Count of cores of this accelerator.
[Newtonsoft.Json.JsonPropertyAttribute("coreCount")]
public virtual System.Nullable CoreCount { get; set; }
/// Type of this accelerator.
[Newtonsoft.Json.JsonPropertyAttribute("type")]
public virtual string Type { get; set; }
/// The ETag of the item.
public virtual string ETag { get; set; }
}
/// Request message for `SetIamPolicy` method.
public class SetIamPolicyRequest : Google.Apis.Requests.IDirectResponseSchema
{
///
/// REQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few
/// 10s of KB. An empty policy is a valid policy but certain Google Cloud services (such as Projects) might
/// reject them.
///
[Newtonsoft.Json.JsonPropertyAttribute("policy")]
public virtual Policy Policy { get; set; }
/// The ETag of the item.
public virtual string ETag { get; set; }
}
/// Request for setting instance accelerator.
public class SetInstanceAcceleratorRequest : Google.Apis.Requests.IDirectResponseSchema
{
///
/// Required. Count of cores of this accelerator. Note that not all combinations of `type` and `core_count` are
/// valid. See [GPUs on Compute Engine](https://cloud.google.com/compute/docs/gpus/#gpus-list) to find a valid
/// combination. TPUs are not supported.
///
[Newtonsoft.Json.JsonPropertyAttribute("coreCount")]
public virtual System.Nullable CoreCount { get; set; }
/// Required. Type of this accelerator.
[Newtonsoft.Json.JsonPropertyAttribute("type")]
public virtual string Type { get; set; }
/// The ETag of the item.
public virtual string ETag { get; set; }
}
/// Request for setting instance labels.
public class SetInstanceLabelsRequest : Google.Apis.Requests.IDirectResponseSchema
{
/// Labels to apply to this instance. These can be later modified by the setLabels method
[Newtonsoft.Json.JsonPropertyAttribute("labels")]
public virtual System.Collections.Generic.IDictionary Labels { get; set; }
/// The ETag of the item.
public virtual string ETag { get; set; }
}
/// Request for setting instance machine type.
public class SetInstanceMachineTypeRequest : Google.Apis.Requests.IDirectResponseSchema
{
///
/// Required. The [Compute Engine machine type](https://cloud.google.com/compute/docs/machine-resource).
///
[Newtonsoft.Json.JsonPropertyAttribute("machineType")]
public virtual string MachineType { get; set; }
/// The ETag of the item.
public virtual string ETag { get; set; }
}
///
/// A set of Shielded Instance options. See [Images using supported Shielded VM
/// features](https://cloud.google.com/compute/docs/instances/modifying-shielded-vm). Not all combinations are
/// valid.
///
public class ShieldedInstanceConfig : Google.Apis.Requests.IDirectResponseSchema
{
///
/// Defines whether the instance has integrity monitoring enabled. Enables monitoring and attestation of the
/// boot integrity of the instance. The attestation is performed against the integrity policy baseline. This
/// baseline is initially derived from the implicitly trusted boot image when the instance is created. Enabled
/// by default.
///
[Newtonsoft.Json.JsonPropertyAttribute("enableIntegrityMonitoring")]
public virtual System.Nullable EnableIntegrityMonitoring { get; set; }
///
/// Defines whether the instance has Secure Boot enabled. Secure Boot helps ensure that the system only runs
/// authentic software by verifying the digital signature of all boot components, and halting the boot process
/// if signature verification fails. Disabled by default.
///
[Newtonsoft.Json.JsonPropertyAttribute("enableSecureBoot")]
public virtual System.Nullable EnableSecureBoot { get; set; }
/// Defines whether the instance has the vTPM enabled. Enabled by default.
[Newtonsoft.Json.JsonPropertyAttribute("enableVtpm")]
public virtual System.Nullable EnableVtpm { get; set; }
/// The ETag of the item.
public virtual string ETag { get; set; }
}
/// Request for starting a notebook instance
public class StartInstanceRequest : Google.Apis.Requests.IDirectResponseSchema
{
/// The ETag of the item.
public virtual string ETag { get; set; }
}
/// Request for starting a Managed Notebook Runtime.
public class StartRuntimeRequest : Google.Apis.Requests.IDirectResponseSchema
{
/// Idempotent request UUID.
[Newtonsoft.Json.JsonPropertyAttribute("requestId")]
public virtual string RequestId { get; set; }
/// The ETag of the item.
public virtual string ETag { get; set; }
}
///
/// The `Status` type defines a logical error model that is suitable for different programming environments,
/// including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains
/// three pieces of data: error code, error message, and error details. You can find out more about this error model
/// and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).
///
public class Status : Google.Apis.Requests.IDirectResponseSchema
{
/// The status code, which should be an enum value of google.rpc.Code.
[Newtonsoft.Json.JsonPropertyAttribute("code")]
public virtual System.Nullable Code { get; set; }
///
/// A list of messages that carry the error details. There is a common set of message types for APIs to use.
///
[Newtonsoft.Json.JsonPropertyAttribute("details")]
public virtual System.Collections.Generic.IList> Details { get; set; }
///
/// A developer-facing error message, which should be in English. Any user-facing error message should be
/// localized and sent in the google.rpc.Status.details field, or localized by the client.
///
[Newtonsoft.Json.JsonPropertyAttribute("message")]
public virtual string Message { get; set; }
/// The ETag of the item.
public virtual string ETag { get; set; }
}
/// Request for stopping a notebook instance
public class StopInstanceRequest : Google.Apis.Requests.IDirectResponseSchema
{
/// The ETag of the item.
public virtual string ETag { get; set; }
}
/// Request for stopping a Managed Notebook Runtime.
public class StopRuntimeRequest : Google.Apis.Requests.IDirectResponseSchema
{
/// Idempotent request UUID.
[Newtonsoft.Json.JsonPropertyAttribute("requestId")]
public virtual string RequestId { get; set; }
/// The ETag of the item.
public virtual string ETag { get; set; }
}
/// Request for switching a Managed Notebook Runtime.
public class SwitchRuntimeRequest : Google.Apis.Requests.IDirectResponseSchema
{
/// accelerator config.
[Newtonsoft.Json.JsonPropertyAttribute("acceleratorConfig")]
public virtual RuntimeAcceleratorConfig AcceleratorConfig { get; set; }
/// machine type.
[Newtonsoft.Json.JsonPropertyAttribute("machineType")]
public virtual string MachineType { get; set; }
/// Idempotent request UUID.
[Newtonsoft.Json.JsonPropertyAttribute("requestId")]
public virtual string RequestId { get; set; }
/// The ETag of the item.
public virtual string ETag { get; set; }
}
/// Request message for `TestIamPermissions` method.
public class TestIamPermissionsRequest : Google.Apis.Requests.IDirectResponseSchema
{
///
/// The set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`)
/// are not allowed. For more information see [IAM
/// Overview](https://cloud.google.com/iam/docs/overview#permissions).
///
[Newtonsoft.Json.JsonPropertyAttribute("permissions")]
public virtual System.Collections.Generic.IList Permissions { get; set; }
/// The ETag of the item.
public virtual string ETag { get; set; }
}
/// Response message for `TestIamPermissions` method.
public class TestIamPermissionsResponse : Google.Apis.Requests.IDirectResponseSchema
{
/// A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
[Newtonsoft.Json.JsonPropertyAttribute("permissions")]
public virtual System.Collections.Generic.IList Permissions { get; set; }
/// The ETag of the item.
public virtual string ETag { get; set; }
}
/// Request for created scheduled notebooks
public class TriggerScheduleRequest : Google.Apis.Requests.IDirectResponseSchema
{
/// The ETag of the item.
public virtual string ETag { get; set; }
}
/// Request for updating instance configurations.
public class UpdateInstanceConfigRequest : Google.Apis.Requests.IDirectResponseSchema
{
/// The instance configurations to be updated.
[Newtonsoft.Json.JsonPropertyAttribute("config")]
public virtual InstanceConfig Config { get; set; }
/// The ETag of the item.
public virtual string ETag { get; set; }
}
/// Request for adding/changing metadata items for an instance.
public class UpdateInstanceMetadataItemsRequest : Google.Apis.Requests.IDirectResponseSchema
{
/// Metadata items to add/update for the instance.
[Newtonsoft.Json.JsonPropertyAttribute("items")]
public virtual System.Collections.Generic.IDictionary Items { get; set; }
/// The ETag of the item.
public virtual string ETag { get; set; }
}
/// Response for adding/changing metadata items for an instance.
public class UpdateInstanceMetadataItemsResponse : Google.Apis.Requests.IDirectResponseSchema
{
/// Map of items that were added/updated to/in the metadata.
[Newtonsoft.Json.JsonPropertyAttribute("items")]
public virtual System.Collections.Generic.IDictionary Items { get; set; }
/// The ETag of the item.
public virtual string ETag { get; set; }
}
///
/// Request for updating the Shielded Instance config for a notebook instance. You can only use this method on a
/// stopped instance
///
public class UpdateShieldedInstanceConfigRequest : Google.Apis.Requests.IDirectResponseSchema
{
/// ShieldedInstance configuration to be updated.
[Newtonsoft.Json.JsonPropertyAttribute("shieldedInstanceConfig")]
public virtual ShieldedInstanceConfig ShieldedInstanceConfig { get; set; }
/// The ETag of the item.
public virtual string ETag { get; set; }
}
/// The entry of VM image upgrade history.
public class UpgradeHistoryEntry : Google.Apis.Requests.IDirectResponseSchema
{
/// Action. Rolloback or Upgrade.
[Newtonsoft.Json.JsonPropertyAttribute("action")]
public virtual string Action { get; set; }
/// The container image before this instance upgrade.
[Newtonsoft.Json.JsonPropertyAttribute("containerImage")]
public virtual string ContainerImage { get; set; }
private string _createTimeRaw;
private object _createTime;
/// The time that this instance upgrade history entry is created.
[Newtonsoft.Json.JsonPropertyAttribute("createTime")]
public virtual string CreateTimeRaw
{
get => _createTimeRaw;
set
{
_createTime = Google.Apis.Util.Utilities.DeserializeForGoogleFormat(value);
_createTimeRaw = value;
}
}
/// representation of .
[Newtonsoft.Json.JsonIgnoreAttribute]
[System.ObsoleteAttribute("This property is obsolete and may behave unexpectedly; please use CreateTimeDateTimeOffset instead.")]
public virtual object CreateTime
{
get => _createTime;
set
{
_createTimeRaw = Google.Apis.Util.Utilities.SerializeForGoogleFormat(value);
_createTime = value;
}
}
/// representation of .
[Newtonsoft.Json.JsonIgnoreAttribute]
public virtual System.DateTimeOffset? CreateTimeDateTimeOffset
{
get => Google.Apis.Util.DiscoveryFormat.ParseGoogleDateTimeToDateTimeOffset(CreateTimeRaw);
set => CreateTimeRaw = Google.Apis.Util.DiscoveryFormat.FormatDateTimeOffsetToGoogleDateTime(value);
}
/// The framework of this notebook instance.
[Newtonsoft.Json.JsonPropertyAttribute("framework")]
public virtual string Framework { get; set; }
/// The snapshot of the boot disk of this notebook instance before upgrade.
[Newtonsoft.Json.JsonPropertyAttribute("snapshot")]
public virtual string Snapshot { get; set; }
/// The state of this instance upgrade history entry.
[Newtonsoft.Json.JsonPropertyAttribute("state")]
public virtual string State { get; set; }
/// Target VM Image. Format: `ainotebooks-vm/project/image-name/name`.
[Newtonsoft.Json.JsonPropertyAttribute("targetImage")]
public virtual string TargetImage { get; set; }
/// Target VM Version, like m63.
[Newtonsoft.Json.JsonPropertyAttribute("targetVersion")]
public virtual string TargetVersion { get; set; }
/// The version of the notebook instance before this upgrade.
[Newtonsoft.Json.JsonPropertyAttribute("version")]
public virtual string Version { get; set; }
/// The VM image before this instance upgrade.
[Newtonsoft.Json.JsonPropertyAttribute("vmImage")]
public virtual string VmImage { get; set; }
/// The ETag of the item.
public virtual string ETag { get; set; }
}
/// Request for upgrading a notebook instance from within the VM
public class UpgradeInstanceInternalRequest : Google.Apis.Requests.IDirectResponseSchema
{
///
/// Optional. The optional UpgradeType. Setting this field will search for additional compute images to upgrade
/// this instance.
///
[Newtonsoft.Json.JsonPropertyAttribute("type")]
public virtual string Type { get; set; }
///
/// Required. The VM hardware token for authenticating the VM.
/// https://cloud.google.com/compute/docs/instances/verifying-instance-identity
///
[Newtonsoft.Json.JsonPropertyAttribute("vmId")]
public virtual string VmId { get; set; }
/// The ETag of the item.
public virtual string ETag { get; set; }
}
/// Request for upgrading a notebook instance
public class UpgradeInstanceRequest : Google.Apis.Requests.IDirectResponseSchema
{
///
/// Optional. The optional UpgradeType. Setting this field will search for additional compute images to upgrade
/// this instance.
///
[Newtonsoft.Json.JsonPropertyAttribute("type")]
public virtual string Type { get; set; }
/// The ETag of the item.
public virtual string ETag { get; set; }
}
///
/// Request for upgrading a Managed Notebook Runtime to the latest version. option
/// (google.api.message_visibility).restriction = "TRUSTED_TESTER,SPECIAL_TESTER";
///
public class UpgradeRuntimeRequest : Google.Apis.Requests.IDirectResponseSchema
{
/// Idempotent request UUID.
[Newtonsoft.Json.JsonPropertyAttribute("requestId")]
public virtual string RequestId { get; set; }
/// The ETag of the item.
public virtual string ETag { get; set; }
}
/// Parameters used in Vertex AI JobType executions.
public class VertexAIParameters : Google.Apis.Requests.IDirectResponseSchema
{
///
/// Environment variables. At most 100 environment variables can be specified and unique. Example:
/// `GCP_BUCKET=gs://my-bucket/samples/`
///
[Newtonsoft.Json.JsonPropertyAttribute("env")]
public virtual System.Collections.Generic.IDictionary Env { get; set; }
///
/// The full name of the Compute Engine
/// [network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks) to which the Job should be
/// peered. For example, `projects/12345/global/networks/myVPC`.
/// [Format](https://cloud.google.com/compute/docs/reference/rest/v1/networks/insert) is of the form
/// `projects/{project}/global/networks/{network}`. Where `{project}` is a project number, as in `12345`, and
/// `{network}` is a network name. Private services access must already be configured for the network. If left
/// unspecified, the job is not peered with any network.
///
[Newtonsoft.Json.JsonPropertyAttribute("network")]
public virtual string Network { get; set; }
/// The ETag of the item.
public virtual string ETag { get; set; }
}
/// Runtime using Virtual Machine for computing.
public class VirtualMachine : Google.Apis.Requests.IDirectResponseSchema
{
/// Output only. The unique identifier of the Managed Compute Engine instance.
[Newtonsoft.Json.JsonPropertyAttribute("instanceId")]
public virtual string InstanceId { get; set; }
/// Output only. The user-friendly name of the Managed Compute Engine instance.
[Newtonsoft.Json.JsonPropertyAttribute("instanceName")]
public virtual string InstanceName { get; set; }
/// Virtual Machine configuration settings.
[Newtonsoft.Json.JsonPropertyAttribute("virtualMachineConfig")]
public virtual VirtualMachineConfig VirtualMachineConfig { get; set; }
/// The ETag of the item.
public virtual string ETag { get; set; }
}
/// The config settings for virtual machine.
public class VirtualMachineConfig : Google.Apis.Requests.IDirectResponseSchema
{
/// Optional. The Compute Engine accelerator configuration for this runtime.
[Newtonsoft.Json.JsonPropertyAttribute("acceleratorConfig")]
public virtual RuntimeAcceleratorConfig AcceleratorConfig { get; set; }
/// Optional. Boot image metadata used for runtime upgradeability.
[Newtonsoft.Json.JsonPropertyAttribute("bootImage")]
public virtual BootImage BootImage { get; set; }
/// Optional. Use a list of container images to use as Kernels in the notebook instance.
[Newtonsoft.Json.JsonPropertyAttribute("containerImages")]
public virtual System.Collections.Generic.IList ContainerImages { get; set; }
/// Required. Data disk option configuration settings.
[Newtonsoft.Json.JsonPropertyAttribute("dataDisk")]
public virtual LocalDisk DataDisk { get; set; }
/// Optional. Encryption settings for virtual machine data disk.
[Newtonsoft.Json.JsonPropertyAttribute("encryptionConfig")]
public virtual EncryptionConfig EncryptionConfig { get; set; }
///
/// Output only. The Compute Engine guest attributes. (see [Project and instance guest
/// attributes](https://cloud.google.com/compute/docs/storing-retrieving-metadata#guest_attributes)).
///
[Newtonsoft.Json.JsonPropertyAttribute("guestAttributes")]
public virtual System.Collections.Generic.IDictionary GuestAttributes { get; set; }
///
/// Optional. If true, runtime will only have internal IP addresses. By default, runtimes are not restricted to
/// internal IP addresses, and will have ephemeral external IP addresses assigned to each vm. This
/// `internal_ip_only` restriction can only be enabled for subnetwork enabled networks, and all dependencies
/// must be configured to be accessible without external IP addresses.
///
[Newtonsoft.Json.JsonPropertyAttribute("internalIpOnly")]
public virtual System.Nullable InternalIpOnly { get; set; }
///
/// Optional. The labels to associate with this runtime. Label **keys** must contain 1 to 63 characters, and
/// must conform to [RFC 1035](https://www.ietf.org/rfc/rfc1035.txt). Label **values** may be empty, but, if
/// present, must contain 1 to 63 characters, and must conform to [RFC
/// 1035](https://www.ietf.org/rfc/rfc1035.txt). No more than 32 labels can be associated with a cluster.
///
[Newtonsoft.Json.JsonPropertyAttribute("labels")]
public virtual System.Collections.Generic.IDictionary Labels { get; set; }
///
/// Required. The Compute Engine machine type used for runtimes. Short name is valid. Examples: *
/// `n1-standard-2` * `e2-standard-8`
///
[Newtonsoft.Json.JsonPropertyAttribute("machineType")]
public virtual string MachineType { get; set; }
///
/// Optional. The Compute Engine metadata entries to add to virtual machine. (see [Project and instance
/// metadata](https://cloud.google.com/compute/docs/storing-retrieving-metadata#project_and_instance_metadata)).
///
[Newtonsoft.Json.JsonPropertyAttribute("metadata")]
public virtual System.Collections.Generic.IDictionary Metadata { get; set; }
///
/// Optional. The Compute Engine network to be used for machine communications. Cannot be specified with
/// subnetwork. If neither `network` nor `subnet` is specified, the "default" network of the project is used, if
/// it exists. A full URL or partial URI. Examples: *
/// `https://www.googleapis.com/compute/v1/projects/[project_id]/global/networks/default` *
/// `projects/[project_id]/global/networks/default` Runtimes are managed resources inside Google Infrastructure.
/// Runtimes support the following network configurations: * Google Managed Network (Network & subnet
/// are empty) * Consumer Project VPC (network & subnet are required). Requires configuring Private
/// Service Access. * Shared VPC (network & subnet are required). Requires configuring Private Service
/// Access.
///
[Newtonsoft.Json.JsonPropertyAttribute("network")]
public virtual string Network { get; set; }
/// Optional. The type of vNIC to be used on this interface. This may be gVNIC or VirtioNet.
[Newtonsoft.Json.JsonPropertyAttribute("nicType")]
public virtual string NicType { get; set; }
///
/// Optional. Reserved IP Range name is used for VPC Peering. The subnetwork allocation will use the range
/// *name* if it's assigned. Example: managed-notebooks-range-c PEERING_RANGE_NAME_3=managed-notebooks-range-c
/// gcloud compute addresses create $PEERING_RANGE_NAME_3 \ --global \ --prefix-length=24 \
/// --description="Google Cloud Managed Notebooks Range 24 c" \ --network=$NETWORK \ --addresses=192.168.0.0 \
/// --purpose=VPC_PEERING Field value will be: `managed-notebooks-range-c`
///
[Newtonsoft.Json.JsonPropertyAttribute("reservedIpRange")]
public virtual string ReservedIpRange { get; set; }
/// Optional. Shielded VM Instance configuration settings.
[Newtonsoft.Json.JsonPropertyAttribute("shieldedInstanceConfig")]
public virtual RuntimeShieldedInstanceConfig ShieldedInstanceConfig { get; set; }
///
/// Optional. The Compute Engine subnetwork to be used for machine communications. Cannot be specified with
/// network. A full URL or partial URI are valid. Examples: *
/// `https://www.googleapis.com/compute/v1/projects/[project_id]/regions/us-east1/subnetworks/sub0` *
/// `projects/[project_id]/regions/us-east1/subnetworks/sub0`
///
[Newtonsoft.Json.JsonPropertyAttribute("subnet")]
public virtual string Subnet { get; set; }
///
/// Optional. The Compute Engine network tags to add to runtime (see [Add network
/// tags](https://cloud.google.com/vpc/docs/add-remove-network-tags)).
///
[Newtonsoft.Json.JsonPropertyAttribute("tags")]
public virtual System.Collections.Generic.IList Tags { get; set; }
///
/// Output only. The zone where the virtual machine is located. If using regional request, the notebooks service
/// will pick a location in the corresponding runtime region. On a get request, zone will always be present.
/// Example: * `us-central1-b`
///
[Newtonsoft.Json.JsonPropertyAttribute("zone")]
public virtual string Zone { get; set; }
/// The ETag of the item.
public virtual string ETag { get; set; }
}
///
/// Definition of a custom Compute Engine virtual machine image for starting a notebook instance with the
/// environment installed directly on the VM.
///
public class VmImage : Google.Apis.Requests.IDirectResponseSchema
{
/// Use this VM image family to find the image; the newest image in this family will be used.
[Newtonsoft.Json.JsonPropertyAttribute("imageFamily")]
public virtual string ImageFamily { get; set; }
/// Use VM image name to find the image.
[Newtonsoft.Json.JsonPropertyAttribute("imageName")]
public virtual string ImageName { get; set; }
///
/// Required. The name of the Google Cloud project that this VM image belongs to. Format: `{project_id}`
///
[Newtonsoft.Json.JsonPropertyAttribute("project")]
public virtual string Project { get; set; }
/// The ETag of the item.
public virtual string ETag { get; set; }
}
}