Class ProjectsResource.LocationsResource.NotebookRuntimesResource.ListRequest

Lists NotebookRuntimes in a Location.

Inheritance
object
ClientServiceRequest
ClientServiceRequest<GoogleCloudAiplatformV1ListNotebookRuntimesResponse>
AiplatformBaseServiceRequest<GoogleCloudAiplatformV1ListNotebookRuntimesResponse>
ProjectsResource.LocationsResource.NotebookRuntimesResource.ListRequest
Implements
Inherited Members
Namespace: Google.Apis.Aiplatform.v1
Assembly: Google.Apis.Aiplatform.v1.dll
Syntax
public class ProjectsResource.LocationsResource.NotebookRuntimesResource.ListRequest : AiplatformBaseServiceRequest<GoogleCloudAiplatformV1ListNotebookRuntimesResponse>, IClientServiceRequest<GoogleCloudAiplatformV1ListNotebookRuntimesResponse>, IClientServiceRequest

Constructors

ListRequest(IClientService, string)

Constructs a new List request.

Declaration
public ListRequest(IClientService service, string parent)
Parameters
Type Name Description
IClientService service
string parent

Properties

Filter

Optional. An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * notebookRuntime supports = and !=. notebookRuntime represents the NotebookRuntime ID, i.e. the last segment of the NotebookRuntime's resource name.

  • displayName supports = and != and regex. * notebookRuntimeTemplate supports = and !=. notebookRuntimeTemplate represents the NotebookRuntimeTemplate ID, i.e. the last segment of the NotebookRuntimeTemplate's resource name. * healthState supports = and !=. healthState enum: [HEALTHY, UNHEALTHY, HEALTH_STATE_UNSPECIFIED]. * runtimeState supports = and !=. runtimeState enum: [RUNTIME_STATE_UNSPECIFIED, RUNNING, BEING_STARTED, BEING_STOPPED, STOPPED, BEING_UPGRADED, ERROR, INVALID]. * runtimeUser supports = and !=. * API version is UI only: uiState supports = and !=. uiState enum: [UI_RESOURCE_STATE_UNSPECIFIED, UI_RESOURCE_STATE_BEING_CREATED, UI_RESOURCE_STATE_ACTIVE, UI_RESOURCE_STATE_BEING_DELETED, UI_RESOURCE_STATE_CREATION_FAILED]. * notebookRuntimeType supports = and !=. notebookRuntimeType enum: [USER_DEFINED, ONE_CLICK]. Some examples: * notebookRuntime="notebookRuntime123" * displayName="myDisplayName" and displayName=~"myDisplayNameRegex" * notebookRuntimeTemplate="notebookRuntimeTemplate321" * healthState=HEALTHY * runtimeState=RUNNING * runtimeUser="test@google.com" * uiState=UI_RESOURCE_STATE_BEING_DELETED * notebookRuntimeType=USER_DEFINED
Declaration
[RequestParameter("filter", RequestParameterType.Query)]
public virtual string Filter { get; set; }
Property Value
Type Description
string

HttpMethod

Gets the HTTP method.

Declaration
public override string HttpMethod { get; }
Property Value
Type Description
string
Overrides

MethodName

Gets the method name.

Declaration
public override string MethodName { get; }
Property Value
Type Description
string
Overrides

OrderBy

Optional. A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * display_name * create_time * update_time Example: display_name, create_time desc.

Declaration
[RequestParameter("orderBy", RequestParameterType.Query)]
public virtual string OrderBy { get; set; }
Property Value
Type Description
string

PageSize

Optional. The standard list page size.

Declaration
[RequestParameter("pageSize", RequestParameterType.Query)]
public virtual int? PageSize { get; set; }
Property Value
Type Description
int?

PageToken

Optional. The standard list page token. Typically obtained via ListNotebookRuntimesResponse.next_page_token of the previous NotebookService.ListNotebookRuntimes call.

Declaration
[RequestParameter("pageToken", RequestParameterType.Query)]
public virtual string PageToken { get; set; }
Property Value
Type Description
string

Parent

Required. The resource name of the Location from which to list the NotebookRuntimes. Format: projects/{project}/locations/{location}

Declaration
[RequestParameter("parent", RequestParameterType.Path)]
public virtual string Parent { get; }
Property Value
Type Description
string

ReadMask

Optional. Mask specifying which fields to read.

Declaration
[RequestParameter("readMask", RequestParameterType.Query)]
public virtual object ReadMask { get; set; }
Property Value
Type Description
object

RestPath

Gets the REST path.

Declaration
public override string RestPath { get; }
Property Value
Type Description
string
Overrides

Methods

InitParameters()

Initializes List parameter list.

Declaration
protected override void InitParameters()
Overrides

Implements