// 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.v2
{
/// The AIPlatformNotebooks Service.
public class AIPlatformNotebooksService : Google.Apis.Services.BaseClientService
{
/// The API version.
public const string Version = "v2";
/// 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;
Instances = new InstancesResource(service);
Operations = new OperationsResource(service);
}
/// 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;
}
///
/// Initiated by Cloud Console for Oauth consent flow for Workbench Instances. Do not use this method
/// directly. Design doc: go/wbi-euc:auth-dd
///
/// The body of the request.
///
/// Required. The name of the Notebook Instance resource. Format:
/// `projects/{project}/locations/{location}/instances/{instance}`
///
public virtual CheckAuthorizationRequest CheckAuthorization(Google.Apis.AIPlatformNotebooks.v2.Data.CheckAuthorizationRequest body, string name)
{
return new CheckAuthorizationRequest(this.service, body, name);
}
///
/// Initiated by Cloud Console for Oauth consent flow for Workbench Instances. Do not use this method
/// directly. Design doc: go/wbi-euc:auth-dd
///
public class CheckAuthorizationRequest : AIPlatformNotebooksBaseServiceRequest
{
/// Constructs a new CheckAuthorization request.
public CheckAuthorizationRequest(Google.Apis.Services.IClientService service, Google.Apis.AIPlatformNotebooks.v2.Data.CheckAuthorizationRequest body, string name) : base(service)
{
Name = name;
Body = body;
InitParameters();
}
///
/// Required. The name of the Notebook Instance resource. Format:
/// `projects/{project}/locations/{location}/instances/{instance}`
///
[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.v2.Data.CheckAuthorizationRequest Body { get; set; }
/// Returns the body of the request.
protected override object GetBody() => Body;
/// Gets the method name.
public override string MethodName => "checkAuthorization";
/// Gets the HTTP method.
public override string HttpMethod => "POST";
/// Gets the REST path.
public override string RestPath => "v2/{+name}:checkAuthorization";
/// Initializes CheckAuthorization 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 CheckUpgradabilityRequest CheckUpgradability(string notebookInstance)
{
return new CheckUpgradabilityRequest(this.service, notebookInstance);
}
/// Checks whether a notebook instance is upgradable.
public class CheckUpgradabilityRequest : AIPlatformNotebooksBaseServiceRequest
{
/// Constructs a new CheckUpgradability request.
public CheckUpgradabilityRequest(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; }
/// Gets the method name.
public override string MethodName => "checkUpgradability";
/// Gets the HTTP method.
public override string HttpMethod => "GET";
/// Gets the REST path.
public override string RestPath => "v2/{+notebookInstance}:checkUpgradability";
/// Initializes CheckUpgradability 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/[^/]+$",
});
}
}
/// 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.v2.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.v2.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; }
/// Optional. Idempotent request UUID.
[Google.Apis.Util.RequestParameterAttribute("requestId", Google.Apis.Util.RequestParameterType.Query)]
public virtual string RequestId { get; set; }
/// Gets or sets the body of this request.
Google.Apis.AIPlatformNotebooks.v2.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 => "v2/{+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,
});
RequestParameters.Add("requestId", new Google.Apis.Discovery.Parameter
{
Name = "requestId",
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; }
/// Optional. 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 => "v2/{+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/[^/]+$",
});
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 an Instance.
/// The body of the request.
///
/// Required. Format: `projects/{project_id}/locations/{location}/instances/{instance_id}`
///
public virtual DiagnoseRequest Diagnose(Google.Apis.AIPlatformNotebooks.v2.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.v2.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.v2.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 => "v2/{+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/[^/]+$",
});
}
}
///
/// Called by VM to return an EUC for the instance owner. Do not use this method directly. Design doc:
/// go/wbi-euc:dd
///
/// The body of the request.
///
/// Required. Format: `projects/{project}/locations/{location}/instances/{instance_id}`
///
public virtual GenerateAccessTokenRequest GenerateAccessToken(Google.Apis.AIPlatformNotebooks.v2.Data.GenerateAccessTokenRequest body, string name)
{
return new GenerateAccessTokenRequest(this.service, body, name);
}
///
/// Called by VM to return an EUC for the instance owner. Do not use this method directly. Design doc:
/// go/wbi-euc:dd
///
public class GenerateAccessTokenRequest : AIPlatformNotebooksBaseServiceRequest
{
/// Constructs a new GenerateAccessToken request.
public GenerateAccessTokenRequest(Google.Apis.Services.IClientService service, Google.Apis.AIPlatformNotebooks.v2.Data.GenerateAccessTokenRequest body, string name) : base(service)
{
Name = name;
Body = body;
InitParameters();
}
///
/// Required. Format: `projects/{project}/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.v2.Data.GenerateAccessTokenRequest Body { get; set; }
/// Returns the body of the request.
protected override object GetBody() => Body;
/// Gets the method name.
public override string MethodName => "generateAccessToken";
/// Gets the HTTP method.
public override string HttpMethod => "POST";
/// Gets the REST path.
public override string RestPath => "v2/{+name}:generateAccessToken";
/// Initializes GenerateAccessToken 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 => "v2/{+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/[^/]+$",
});
}
}
/// Returns various configuration parameters.
/// Required. Format: `projects/{project_id}/locations/{location}`
public virtual GetConfigRequest GetConfig(string name)
{
return new GetConfigRequest(this.service, name);
}
/// Returns various configuration parameters.
public class GetConfigRequest : AIPlatformNotebooksBaseServiceRequest
{
/// Constructs a new GetConfig request.
public GetConfigRequest(Google.Apis.Services.IClientService service, string name) : base(service)
{
Name = name;
InitParameters();
}
/// Required. Format: `projects/{project_id}/locations/{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 => "getConfig";
/// Gets the HTTP method.
public override string HttpMethod => "GET";
/// Gets the REST path.
public override string RestPath => "v2/{+name}/instances:getConfig";
/// Initializes GetConfig 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/[^/]+$",
});
}
}
///
/// 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 => "v2/{+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,
});
}
}
/// 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; }
/// Optional. Maximum return size of the list call.
[Google.Apis.Util.RequestParameterAttribute("pageSize", Google.Apis.Util.RequestParameterType.Query)]
public virtual System.Nullable PageSize { get; set; }
///
/// Optional. 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 => "v2/{+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,
});
}
}
/// UpdateInstance updates an Instance.
/// The body of the request.
///
/// Output only. Identifier. The name of this notebook instance. Format:
/// `projects/{project_id}/locations/{location}/instances/{instance_id}`
///
public virtual PatchRequest Patch(Google.Apis.AIPlatformNotebooks.v2.Data.Instance body, string name)
{
return new PatchRequest(this.service, body, name);
}
/// UpdateInstance updates an Instance.
public class PatchRequest : AIPlatformNotebooksBaseServiceRequest
{
/// Constructs a new Patch request.
public PatchRequest(Google.Apis.Services.IClientService service, Google.Apis.AIPlatformNotebooks.v2.Data.Instance body, string name) : base(service)
{
Name = name;
Body = body;
InitParameters();
}
///
/// Output only. Identifier. The name of this notebook instance. 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; }
/// Optional. Idempotent request UUID.
[Google.Apis.Util.RequestParameterAttribute("requestId", Google.Apis.Util.RequestParameterType.Query)]
public virtual string RequestId { get; set; }
///
/// Required. Mask used to update an instance. Updatable fields: * `labels` *
/// `gce_setup.min_cpu_platform` * `gce_setup.metadata` * `gce_setup.machine_type` *
/// `gce_setup.accelerator_configs` * `gce_setup.accelerator_configs.type` *
/// `gce_setup.accelerator_configs.core_count` * `gce_setup.gpu_driver_config` *
/// `gce_setup.gpu_driver_config.enable_gpu_driver` *
/// `gce_setup.gpu_driver_config.custom_gpu_driver_path` * `gce_setup.shielded_instance_config` *
/// `gce_setup.shielded_instance_config.enable_secure_boot` *
/// `gce_setup.shielded_instance_config.enable_vtpm` *
/// `gce_setup.shielded_instance_config.enable_integrity_monitoring` *
/// `gce_setup.reservation_affinity` * `gce_setup.reservation_affinity.consume_reservation_type` *
/// `gce_setup.reservation_affinity.key` * `gce_setup.reservation_affinity.values` *
/// `gce_setup.tags` * `gce_setup.container_image` * `gce_setup.container_image.repository` *
/// `gce_setup.container_image.tag` * `gce_setup.disable_public_ip` * `disable_proxy_access`
///
[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.v2.Data.Instance 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 => "v2/{+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/[^/]+/instances/[^/]+$",
});
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,
});
}
}
///
/// 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 ReportInfoSystemRequest ReportInfoSystem(Google.Apis.AIPlatformNotebooks.v2.Data.ReportInstanceInfoSystemRequest body, string name)
{
return new ReportInfoSystemRequest(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 ReportInfoSystemRequest : AIPlatformNotebooksBaseServiceRequest
{
/// Constructs a new ReportInfoSystem request.
public ReportInfoSystemRequest(Google.Apis.Services.IClientService service, Google.Apis.AIPlatformNotebooks.v2.Data.ReportInstanceInfoSystemRequest 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.v2.Data.ReportInstanceInfoSystemRequest Body { get; set; }
/// Returns the body of the request.
protected override object GetBody() => Body;
/// Gets the method name.
public override string MethodName => "reportInfoSystem";
/// Gets the HTTP method.
public override string HttpMethod => "POST";
/// Gets the REST path.
public override string RestPath => "v2/{+name}:reportInfoSystem";
/// Initializes ReportInfoSystem 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.v2.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.v2.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.v2.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 => "v2/{+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/[^/]+$",
});
}
}
/// Resize a notebook instance disk to a higher capacity.
/// The body of the request.
///
/// Required. Format: `projects/{project_id}/locations/{location}/instances/{instance_id}`
///
public virtual ResizeDiskRequest ResizeDisk(Google.Apis.AIPlatformNotebooks.v2.Data.ResizeDiskRequest body, string notebookInstance)
{
return new ResizeDiskRequest(this.service, body, notebookInstance);
}
/// Resize a notebook instance disk to a higher capacity.
public class ResizeDiskRequest : AIPlatformNotebooksBaseServiceRequest
{
/// Constructs a new ResizeDisk request.
public ResizeDiskRequest(Google.Apis.Services.IClientService service, Google.Apis.AIPlatformNotebooks.v2.Data.ResizeDiskRequest body, string notebookInstance) : base(service)
{
NotebookInstance = notebookInstance;
Body = body;
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; }
/// Gets or sets the body of this request.
Google.Apis.AIPlatformNotebooks.v2.Data.ResizeDiskRequest Body { get; set; }
/// Returns the body of the request.
protected override object GetBody() => Body;
/// Gets the method name.
public override string MethodName => "resizeDisk";
/// Gets the HTTP method.
public override string HttpMethod => "POST";
/// Gets the REST path.
public override string RestPath => "v2/{+notebookInstance}:resizeDisk";
/// Initializes ResizeDisk 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/[^/]+$",
});
}
}
/// RestoreInstance restores an Instance from a BackupSource.
/// The body of the request.
///
/// Required. Format: `projects/{project_id}/locations/{location}/instances/{instance_id}`
///
public virtual RestoreRequest Restore(Google.Apis.AIPlatformNotebooks.v2.Data.RestoreInstanceRequest body, string name)
{
return new RestoreRequest(this.service, body, name);
}
/// RestoreInstance restores an Instance from a BackupSource.
public class RestoreRequest : AIPlatformNotebooksBaseServiceRequest
{
/// Constructs a new Restore request.
public RestoreRequest(Google.Apis.Services.IClientService service, Google.Apis.AIPlatformNotebooks.v2.Data.RestoreInstanceRequest 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.v2.Data.RestoreInstanceRequest Body { get; set; }
/// Returns the body of the request.
protected override object GetBody() => Body;
/// Gets the method name.
public override string MethodName => "restore";
/// Gets the HTTP method.
public override string HttpMethod => "POST";
/// Gets the REST path.
public override string RestPath => "v2/{+name}:restore";
/// Initializes Restore 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.v2.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.v2.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.v2.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 => "v2/{+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/[^/]+$",
});
}
}
///
/// 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.v2.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.v2.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.v2.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 => "v2/{+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/[^/]+$",
});
}
}
/// 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.v2.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.v2.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.v2.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 => "v2/{+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.v2.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.v2.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.v2.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 => "v2/{+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.v2.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.v2.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.v2.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 => "v2/{+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/[^/]+$",
});
}
}
/// 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.v2.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.v2.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.v2.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 => "v2/{+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 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 UpgradeSystemRequest UpgradeSystem(Google.Apis.AIPlatformNotebooks.v2.Data.UpgradeInstanceSystemRequest body, string name)
{
return new UpgradeSystemRequest(this.service, body, name);
}
/// Allows notebook instances to upgrade themselves. Do not use this method directly.
public class UpgradeSystemRequest : AIPlatformNotebooksBaseServiceRequest
{
/// Constructs a new UpgradeSystem request.
public UpgradeSystemRequest(Google.Apis.Services.IClientService service, Google.Apis.AIPlatformNotebooks.v2.Data.UpgradeInstanceSystemRequest 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.v2.Data.UpgradeInstanceSystemRequest Body { get; set; }
/// Returns the body of the request.
protected override object GetBody() => Body;
/// Gets the method name.
public override string MethodName => "upgradeSystem";
/// Gets the HTTP method.
public override string HttpMethod => "POST";
/// Gets the REST path.
public override string RestPath => "v2/{+name}:upgradeSystem";
/// Initializes UpgradeSystem 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.v2.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.v2.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.v2.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 => "v2/{+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 => "v2/{+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 => "v2/{+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 => "v2/{+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 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 => "v2/{+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 => "v2/{+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.v2.Data
{
///
/// An accelerator configuration for a VM instance Definition of a hardware accelerator. Note that there is no check
/// on `type` and `core_count` combinations. TPUs are not supported. See [GPUs on Compute
/// Engine](https://cloud.google.com/compute/docs/gpus/#gpus-list) to find a valid combination.
///
public class AcceleratorConfig : Google.Apis.Requests.IDirectResponseSchema
{
/// Optional. Count of cores of this accelerator.
[Newtonsoft.Json.JsonPropertyAttribute("coreCount")]
public virtual System.Nullable CoreCount { get; set; }
/// Optional. 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; }
}
/// An access configuration attached to an instance's network interface.
public class AccessConfig : Google.Apis.Requests.IDirectResponseSchema
{
///
/// An external IP address associated with this instance. Specify an unused static external IP address available
/// to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you
/// specify a static external IP address, it must live in the same region as the zone of the instance.
///
[Newtonsoft.Json.JsonPropertyAttribute("externalIp")]
public virtual string ExternalIp { 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; }
}
/// The definition of a boot disk.
public class BootDisk : Google.Apis.Requests.IDirectResponseSchema
{
///
/// Optional. 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; }
///
/// Optional. The size of the boot disk in GB attached to this instance, up to a maximum of 64000 GB (64 TB). If
/// not specified, this defaults to the recommended value of 150GB.
///
[Newtonsoft.Json.JsonPropertyAttribute("diskSizeGb")]
public virtual System.Nullable DiskSizeGb { get; set; }
/// Optional. Indicates the type of the disk.
[Newtonsoft.Json.JsonPropertyAttribute("diskType")]
public virtual string DiskType { get; set; }
///
/// Optional. 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.
///
[Newtonsoft.Json.JsonPropertyAttribute("kmsKey")]
public virtual string KmsKey { get; set; }
/// 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; }
}
/// Request message for checking authorization for the instance owner.
public class CheckAuthorizationRequest : Google.Apis.Requests.IDirectResponseSchema
{
///
/// Optional. The details of the OAuth authorization response. This may include additional params such as
/// dry_run, version_info, origin, propagate, etc.
///
[Newtonsoft.Json.JsonPropertyAttribute("authorizationDetails")]
public virtual System.Collections.Generic.IDictionary AuthorizationDetails { get; set; }
/// The ETag of the item.
public virtual string ETag { get; set; }
}
/// Response message for checking authorization for the instance owner.
public class CheckAuthorizationResponse : Google.Apis.Requests.IDirectResponseSchema
{
private string _createTimeRaw;
private object _createTime;
/// Output only. Timestamp when this Authorization request 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);
}
///
/// If the user has not completed OAuth consent, then the oauth_url is returned. Otherwise, this field is not
/// set.
///
[Newtonsoft.Json.JsonPropertyAttribute("oauth_uri")]
public virtual string OauthUri { get; set; }
///
/// Success indicates that the user completed OAuth consent and access tokens can be generated.
///
[Newtonsoft.Json.JsonPropertyAttribute("success")]
public virtual System.Nullable Success { get; set; }
/// The ETag of the item.
public virtual string ETag { get; set; }
}
/// Response for checking if a notebook instance is upgradeable.
public class CheckInstanceUpgradabilityResponse : 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; }
}
/// A set of Confidential Instance options.
public class ConfidentialInstanceConfig : Google.Apis.Requests.IDirectResponseSchema
{
/// Optional. Defines the type of technology used by the confidential instance.
[Newtonsoft.Json.JsonPropertyAttribute("confidentialInstanceType")]
public virtual string ConfidentialInstanceType { get; set; }
/// The ETag of the item.
public virtual string ETag { get; set; }
}
/// Response for getting WbI configurations in a location
public class Config : Google.Apis.Requests.IDirectResponseSchema
{
/// Output only. The list of available images to create a WbI.
[Newtonsoft.Json.JsonPropertyAttribute("availableImages")]
public virtual System.Collections.Generic.IList AvailableImages { get; set; }
/// Output only. The default values for configuration.
[Newtonsoft.Json.JsonPropertyAttribute("defaultValues")]
public virtual DefaultValues DefaultValues { get; set; }
///
/// Output only. Flag to disable the creation of legacy Workbench notebooks (User-managed notebooks and
/// Google-managed notebooks).
///
[Newtonsoft.Json.JsonPropertyAttribute("disableWorkbenchLegacyCreation")]
public virtual System.Nullable DisableWorkbenchLegacyCreation { get; set; }
/// Output only. The supported values for configuration.
[Newtonsoft.Json.JsonPropertyAttribute("supportedValues")]
public virtual SupportedValues SupportedValues { get; set; }
/// 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; }
///
/// Optional. 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; }
}
/// An instance-attached disk resource.
public class DataDisk : Google.Apis.Requests.IDirectResponseSchema
{
///
/// Optional. 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; }
///
/// Optional. The size of the disk in GB attached to this VM instance, up to a maximum of 64000 GB (64 TB). If
/// not specified, this defaults to 100.
///
[Newtonsoft.Json.JsonPropertyAttribute("diskSizeGb")]
public virtual System.Nullable DiskSizeGb { get; set; }
/// Optional. Input only. Indicates the type of the disk.
[Newtonsoft.Json.JsonPropertyAttribute("diskType")]
public virtual string DiskType { get; set; }
///
/// Optional. 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.
///
[Newtonsoft.Json.JsonPropertyAttribute("kmsKey")]
public virtual string KmsKey { get; set; }
/// Optional. The resource policies to apply to the data disk.
[Newtonsoft.Json.JsonPropertyAttribute("resourcePolicies")]
public virtual System.Collections.Generic.IList ResourcePolicies { get; set; }
/// The ETag of the item.
public virtual string ETag { get; set; }
}
/// DefaultValues represents the default configuration values.
public class DefaultValues : Google.Apis.Requests.IDirectResponseSchema
{
/// Output only. The default machine type used by the backend if not provided by the user.
[Newtonsoft.Json.JsonPropertyAttribute("machineType")]
public virtual string MachineType { 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; }
}
/// 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("enableCopyHomeFilesFlag")]
public virtual System.Nullable EnableCopyHomeFilesFlag { get; set; }
/// Optional. Enables flag to capture packets from the instance for 30 seconds
[Newtonsoft.Json.JsonPropertyAttribute("enablePacketCaptureFlag")]
public virtual System.Nullable EnablePacketCaptureFlag { get; set; }
/// Optional. Enables flag to repair service for instance
[Newtonsoft.Json.JsonPropertyAttribute("enableRepairFlag")]
public virtual System.Nullable EnableRepairFlag { 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. 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; }
/// 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; }
}
/// 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;
/// Optional. 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);
}
/// Optional. Event type.
[Newtonsoft.Json.JsonPropertyAttribute("type")]
public virtual string Type { 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; }
}
/// A GPU driver configuration
public class GPUDriverConfig : Google.Apis.Requests.IDirectResponseSchema
{
///
/// Optional. 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; }
///
/// Optional. Whether the end user authorizes Google Cloud to install GPU driver on this VM 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("enableGpuDriver")]
public virtual System.Nullable EnableGpuDriver { get; set; }
/// The ETag of the item.
public virtual string ETag { get; set; }
}
/// The definition of how to configure a VM instance outside of Resources and Identity.
public class GceSetup : Google.Apis.Requests.IDirectResponseSchema
{
///
/// Optional. The hardware accelerators 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). Currently supports only one accelerator
/// configuration.
///
[Newtonsoft.Json.JsonPropertyAttribute("acceleratorConfigs")]
public virtual System.Collections.Generic.IList AcceleratorConfigs { get; set; }
/// Optional. The boot disk for the VM.
[Newtonsoft.Json.JsonPropertyAttribute("bootDisk")]
public virtual BootDisk BootDisk { get; set; }
/// Optional. Confidential instance configuration.
[Newtonsoft.Json.JsonPropertyAttribute("confidentialInstanceConfig")]
public virtual ConfidentialInstanceConfig ConfidentialInstanceConfig { get; set; }
/// Optional. Use a container image to start the notebook instance.
[Newtonsoft.Json.JsonPropertyAttribute("containerImage")]
public virtual ContainerImage ContainerImage { get; set; }
/// Optional. Data disks attached to the VM instance. Currently supports only one data disk.
[Newtonsoft.Json.JsonPropertyAttribute("dataDisks")]
public virtual System.Collections.Generic.IList DataDisks { get; set; }
/// Optional. If true, no external IP will be assigned to this VM instance.
[Newtonsoft.Json.JsonPropertyAttribute("disablePublicIp")]
public virtual System.Nullable DisablePublicIp { 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("enableIpForwarding")]
public virtual System.Nullable EnableIpForwarding { get; set; }
/// Optional. Configuration for GPU drivers.
[Newtonsoft.Json.JsonPropertyAttribute("gpuDriverConfig")]
public virtual GPUDriverConfig GpuDriverConfig { get; set; }
/// Output only. The unique ID of the Compute Engine instance resource.
[Newtonsoft.Json.JsonPropertyAttribute("instanceId")]
public virtual string InstanceId { get; set; }
///
/// Optional. The machine type of the VM instance. https://cloud.google.com/compute/docs/machine-resource
///
[Newtonsoft.Json.JsonPropertyAttribute("machineType")]
public virtual string MachineType { get; set; }
/// Optional. Custom metadata to apply to this instance.
[Newtonsoft.Json.JsonPropertyAttribute("metadata")]
public virtual System.Collections.Generic.IDictionary Metadata { get; set; }
///
/// Optional. The minimum CPU platform to use for this instance. The list of valid values can be found in
/// https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform#availablezones
///
[Newtonsoft.Json.JsonPropertyAttribute("minCpuPlatform")]
public virtual string MinCpuPlatform { get; set; }
/// Optional. The network interfaces for the VM. Supports only one interface.
[Newtonsoft.Json.JsonPropertyAttribute("networkInterfaces")]
public virtual System.Collections.Generic.IList NetworkInterfaces { get; set; }
/// Optional. Specifies the reservations that this instance can consume from.
[Newtonsoft.Json.JsonPropertyAttribute("reservationAffinity")]
public virtual ReservationAffinity ReservationAffinity { get; set; }
///
/// Optional. The service account that serves as an identity for the VM instance. Currently supports only one
/// service account.
///
[Newtonsoft.Json.JsonPropertyAttribute("serviceAccounts")]
public virtual System.Collections.Generic.IList ServiceAccounts { 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; }
///
/// 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; }
/// Optional. 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; }
}
/// Request message for generating an EUC for the instance owner.
public class GenerateAccessTokenRequest : Google.Apis.Requests.IDirectResponseSchema
{
///
/// Required. The VM identity token (a JWT) for authenticating the VM.
/// https://cloud.google.com/compute/docs/instances/verifying-instance-identity
///
[Newtonsoft.Json.JsonPropertyAttribute("vmToken")]
public virtual string VmToken { get; set; }
/// The ETag of the item.
public virtual string ETag { get; set; }
}
/// Response message for generating an EUC for the instance owner.
public class GenerateAccessTokenResponse : Google.Apis.Requests.IDirectResponseSchema
{
/// Short-lived access token string which may be used to access Google APIs.
[Newtonsoft.Json.JsonPropertyAttribute("access_token")]
public virtual string AccessToken { get; set; }
/// The time in seconds when the access token expires. Typically that's 3600.
[Newtonsoft.Json.JsonPropertyAttribute("expires_in")]
public virtual System.Nullable ExpiresIn { get; set; }
///
/// Space-separated list of scopes contained in the returned token.
/// https://cloud.google.com/docs/authentication/token-types#access-contents
///
[Newtonsoft.Json.JsonPropertyAttribute("scope")]
public virtual string Scope { get; set; }
///
/// Type of the returned access token (e.g. "Bearer"). It specifies how the token must be used. Bearer tokens
/// may be used by any entity without proof of identity.
///
[Newtonsoft.Json.JsonPropertyAttribute("token_type")]
public virtual string TokenType { get; set; }
/// The ETag of the item.
public virtual string ETag { get; set; }
}
/// ConfigImage represents an image release available to create a WbI
public class ImageRelease : Google.Apis.Requests.IDirectResponseSchema
{
/// Output only. The name of the image of the form workbench-instances-vYYYYmmdd--
[Newtonsoft.Json.JsonPropertyAttribute("imageName")]
public virtual string ImageName { get; set; }
/// Output only. The release of the image of the form m123
[Newtonsoft.Json.JsonPropertyAttribute("releaseName")]
public virtual string ReleaseName { 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
{
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; }
/// Optional. If true, the notebook instance will not register with the proxy.
[Newtonsoft.Json.JsonPropertyAttribute("disableProxyAccess")]
public virtual System.Nullable DisableProxyAccess { get; set; }
///
/// Optional. If true, deletion protection will be enabled for this Workbench Instance. If false, deletion
/// protection will be disabled for this Workbench Instance.
///
[Newtonsoft.Json.JsonPropertyAttribute("enableDeletionProtection")]
public virtual System.Nullable EnableDeletionProtection { get; set; }
/// Optional. Flag to enable managed end user credentials for the instance.
[Newtonsoft.Json.JsonPropertyAttribute("enableManagedEuc")]
public virtual System.Nullable EnableManagedEuc { get; set; }
///
/// Optional. Flag that specifies that a notebook can be accessed with third party identity provider.
///
[Newtonsoft.Json.JsonPropertyAttribute("enableThirdPartyIdentity")]
public virtual System.Nullable EnableThirdPartyIdentity { get; set; }
/// Optional. Compute Engine setup for the notebook. Uses notebook-defined fields.
[Newtonsoft.Json.JsonPropertyAttribute("gceSetup")]
public virtual GceSetup GceSetup { get; set; }
///
/// 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. Instance health_state.
[Newtonsoft.Json.JsonPropertyAttribute("healthState")]
public virtual string HealthState { get; set; }
/// Output only. Unique ID of the resource.
[Newtonsoft.Json.JsonPropertyAttribute("id")]
public virtual string Id { get; set; }
///
/// Optional. 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; }
///
/// Optional. Labels to apply to this instance. These can be later modified by the UpdateInstance method.
///
[Newtonsoft.Json.JsonPropertyAttribute("labels")]
public virtual System.Collections.Generic.IDictionary Labels { get; set; }
///
/// Output only. Identifier. 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; }
/// Output only. The proxy endpoint that is used to access the Jupyter notebook.
[Newtonsoft.Json.JsonPropertyAttribute("proxyUri")]
public virtual string ProxyUri { get; set; }
/// Output only. Reserved for future use for Zone Isolation.
[Newtonsoft.Json.JsonPropertyAttribute("satisfiesPzi")]
public virtual System.Nullable SatisfiesPzi { get; set; }
/// Output only. Reserved for future use for Zone Separation.
[Newtonsoft.Json.JsonPropertyAttribute("satisfiesPzs")]
public virtual System.Nullable SatisfiesPzs { get; set; }
/// Output only. The state of this instance.
[Newtonsoft.Json.JsonPropertyAttribute("state")]
public virtual string State { get; set; }
///
/// Output only. The workforce pools proxy endpoint that is used to access the Jupyter notebook.
///
[Newtonsoft.Json.JsonPropertyAttribute("thirdPartyProxyUrl")]
public virtual string ThirdPartyProxyUrl { 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);
}
/// Output only. The upgrade history of this instance.
[Newtonsoft.Json.JsonPropertyAttribute("upgradeHistory")]
public virtual System.Collections.Generic.IList UpgradeHistory { 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; }
}
/// 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; }
}
/// The definition of a network interface resource attached to a VM.
public class NetworkInterface : Google.Apis.Requests.IDirectResponseSchema
{
///
/// Optional. An array of configurations for this interface. Currently, only one access config, ONE_TO_ONE_NAT,
/// is supported. If no accessConfigs specified, the instance will have an external internet access through an
/// ephemeral external IP address.
///
[Newtonsoft.Json.JsonPropertyAttribute("accessConfigs")]
public virtual System.Collections.Generic.IList AccessConfigs { get; set; }
///
/// Optional. The name of the VPC that this VM 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; }
///
/// Optional. The name of the subnet that this VM instance is in. 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 notebook instances to report information to Notebooks API.
public class ReportInstanceInfoSystemRequest : 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; }
}
/// A reservation that an instance can consume from.
public class ReservationAffinity : Google.Apis.Requests.IDirectResponseSchema
{
///
/// Required. Specifies the type of reservation from which this instance can consume resources: RESERVATION_ANY
/// (default), RESERVATION_SPECIFIC, or RESERVATION_NONE. See Consuming reserved instances for examples.
///
[Newtonsoft.Json.JsonPropertyAttribute("consumeReservationType")]
public virtual string ConsumeReservationType { get; set; }
///
/// Optional. Corresponds to the label key of a reservation resource. To target a RESERVATION_SPECIFIC by name,
/// use compute.googleapis.com/reservation-name as the key and specify the name of your reservation as its
/// value.
///
[Newtonsoft.Json.JsonPropertyAttribute("key")]
public virtual string Key { get; set; }
///
/// Optional. Corresponds to the label values of a reservation resource. This can be either a name to a
/// reservation in the same project or "projects/different-project/reservations/some-reservation-name" to target
/// a shared reservation in the same zone but in a different project.
///
[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 resizing the notebook instance disks
public class ResizeDiskRequest : Google.Apis.Requests.IDirectResponseSchema
{
/// Required. The boot disk to be resized. Only disk_size_gb will be used.
[Newtonsoft.Json.JsonPropertyAttribute("bootDisk")]
public virtual BootDisk BootDisk { get; set; }
/// Required. The data disk to be resized. Only disk_size_gb will be used.
[Newtonsoft.Json.JsonPropertyAttribute("dataDisk")]
public virtual DataDisk DataDisk { get; set; }
/// The ETag of the item.
public virtual string ETag { get; set; }
}
/// Request for restoring the notebook instance from a BackupSource.
public class RestoreInstanceRequest : Google.Apis.Requests.IDirectResponseSchema
{
/// Snapshot to be used for restore.
[Newtonsoft.Json.JsonPropertyAttribute("snapshot")]
public virtual Snapshot Snapshot { 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. Output only. Revision Id
[Newtonsoft.Json.JsonPropertyAttribute("revisionId")]
public virtual string RevisionId { get; set; }
///
/// 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; }
}
/// A service account that acts as an identity.
public class ServiceAccount : Google.Apis.Requests.IDirectResponseSchema
{
/// Optional. Email address of the service account.
[Newtonsoft.Json.JsonPropertyAttribute("email")]
public virtual string Email { get; set; }
///
/// Output only. The list of scopes to be made available for this service account. Set by the CLH to
/// https://www.googleapis.com/auth/cloud-platform
///
[Newtonsoft.Json.JsonPropertyAttribute("scopes")]
public virtual System.Collections.Generic.IList Scopes { 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; }
}
///
/// 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
{
///
/// Optional. Defines whether the VM instance has integrity monitoring enabled. Enables monitoring and
/// attestation of the boot integrity of the VM instance. The attestation is performed against the integrity
/// policy baseline. This baseline is initially derived from the implicitly trusted boot image when the VM
/// instance is created.
///
[Newtonsoft.Json.JsonPropertyAttribute("enableIntegrityMonitoring")]
public virtual System.Nullable EnableIntegrityMonitoring { get; set; }
///
/// Optional. Defines whether the VM 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; }
/// Optional. Defines whether the VM instance has the vTPM enabled.
[Newtonsoft.Json.JsonPropertyAttribute("enableVtpm")]
public virtual System.Nullable EnableVtpm { get; set; }
/// The ETag of the item.
public virtual string ETag { get; set; }
}
///
/// Snapshot represents the snapshot of the data disk used to restore the Workbench Instance from. Refers to:
/// compute/v1/projects/{project_id}/global/snapshots/{snapshot_id}
///
public class Snapshot : Google.Apis.Requests.IDirectResponseSchema
{
/// Required. The project ID of the snapshot.
[Newtonsoft.Json.JsonPropertyAttribute("projectId")]
public virtual string ProjectId { get; set; }
/// Required. The ID of the snapshot.
[Newtonsoft.Json.JsonPropertyAttribute("snapshotId")]
public virtual string SnapshotId { 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; }
}
///
/// 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; }
}
/// SupportedValues represents the values supported by the configuration.
public class SupportedValues : Google.Apis.Requests.IDirectResponseSchema
{
/// Output only. The accelerator types supported by WbI.
[Newtonsoft.Json.JsonPropertyAttribute("acceleratorTypes")]
public virtual System.Collections.Generic.IList AcceleratorTypes { get; set; }
/// Output only. The machine types supported by WbI.
[Newtonsoft.Json.JsonPropertyAttribute("machineTypes")]
public virtual System.Collections.Generic.IList MachineTypes { 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; }
}
/// The entry of VM image upgrade history.
public class UpgradeHistoryEntry : Google.Apis.Requests.IDirectResponseSchema
{
/// Optional. Action. Rolloback or Upgrade.
[Newtonsoft.Json.JsonPropertyAttribute("action")]
public virtual string Action { get; set; }
/// Optional. The container image before this instance upgrade.
[Newtonsoft.Json.JsonPropertyAttribute("containerImage")]
public virtual string ContainerImage { get; set; }
private string _createTimeRaw;
private object _createTime;
/// Immutable. 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);
}
/// Optional. The framework of this notebook instance.
[Newtonsoft.Json.JsonPropertyAttribute("framework")]
public virtual string Framework { get; set; }
/// Optional. The snapshot of the boot disk of this notebook instance before upgrade.
[Newtonsoft.Json.JsonPropertyAttribute("snapshot")]
public virtual string Snapshot { get; set; }
/// Output only. The state of this instance upgrade history entry.
[Newtonsoft.Json.JsonPropertyAttribute("state")]
public virtual string State { get; set; }
/// Optional. Target VM Version, like m63.
[Newtonsoft.Json.JsonPropertyAttribute("targetVersion")]
public virtual string TargetVersion { get; set; }
/// Optional. The version of the notebook instance before this upgrade.
[Newtonsoft.Json.JsonPropertyAttribute("version")]
public virtual string Version { get; set; }
/// Optional. 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
public class UpgradeInstanceRequest : Google.Apis.Requests.IDirectResponseSchema
{
/// The ETag of the item.
public virtual string ETag { get; set; }
}
/// Request for upgrading a notebook instance from within the VM
public class UpgradeInstanceSystemRequest : 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; }
}
///
/// 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
{
///
/// Optional. Use this VM image family to find the image; the newest image in this family will be used.
///
[Newtonsoft.Json.JsonPropertyAttribute("family")]
public virtual string Family { get; set; }
/// Optional. Use VM image name to find the image.
[Newtonsoft.Json.JsonPropertyAttribute("name")]
public virtual string Name { 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; }
}
}