Class ListNotebookRuntimeTemplatesRequest.Builder (3.43.0)

public static final class ListNotebookRuntimeTemplatesRequest.Builder extends GeneratedMessageV3.Builder<ListNotebookRuntimeTemplatesRequest.Builder> implements ListNotebookRuntimeTemplatesRequestOrBuilder

Request message for NotebookService.ListNotebookRuntimeTemplates.

Protobuf type google.cloud.aiplatform.v1beta1.ListNotebookRuntimeTemplatesRequest

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public ListNotebookRuntimeTemplatesRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
ListNotebookRuntimeTemplatesRequest.Builder
Overrides

build()

public ListNotebookRuntimeTemplatesRequest build()
Returns
Type Description
ListNotebookRuntimeTemplatesRequest

buildPartial()

public ListNotebookRuntimeTemplatesRequest buildPartial()
Returns
Type Description
ListNotebookRuntimeTemplatesRequest

clear()

public ListNotebookRuntimeTemplatesRequest.Builder clear()
Returns
Type Description
ListNotebookRuntimeTemplatesRequest.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public ListNotebookRuntimeTemplatesRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
ListNotebookRuntimeTemplatesRequest.Builder
Overrides

clearFilter()

public ListNotebookRuntimeTemplatesRequest.Builder clearFilter()

Optional. An expression for filtering the results of the request. For field names both snake_case and camelCase are supported.

  • notebookRuntimeTemplate supports = and !=. notebookRuntimeTemplate represents the NotebookRuntimeTemplate ID, i.e. the last segment of the NotebookRuntimeTemplate's [resource name] [google.cloud.aiplatform.v1beta1.NotebookRuntimeTemplate.name].
  • display_name supports = and !=
  • labels supports general map functions that is:
    • labels.key=value - key:value equality
    • labels.key:* or labels:key - key existence
    • A key including a space must be quoted. labels."a key".
  • notebookRuntimeType supports = and !=. notebookRuntimeType enum: [USER_DEFINED, ONE_CLICK].

    Some examples:

  • notebookRuntimeTemplate=notebookRuntimeTemplate123

  • displayName="myDisplayName"
  • labels.myKey="myValue"
  • notebookRuntimeType=USER_DEFINED`

string filter = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ListNotebookRuntimeTemplatesRequest.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public ListNotebookRuntimeTemplatesRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
ListNotebookRuntimeTemplatesRequest.Builder
Overrides

clearOrderBy()

public ListNotebookRuntimeTemplatesRequest.Builder clearOrderBy()

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.

string order_by = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ListNotebookRuntimeTemplatesRequest.Builder

This builder for chaining.

clearPageSize()

public ListNotebookRuntimeTemplatesRequest.Builder clearPageSize()

Optional. The standard list page size.

int32 page_size = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ListNotebookRuntimeTemplatesRequest.Builder

This builder for chaining.

clearPageToken()

public ListNotebookRuntimeTemplatesRequest.Builder clearPageToken()

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

string page_token = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ListNotebookRuntimeTemplatesRequest.Builder

This builder for chaining.

clearParent()

public ListNotebookRuntimeTemplatesRequest.Builder clearParent()

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

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
ListNotebookRuntimeTemplatesRequest.Builder

This builder for chaining.

clearReadMask()

public ListNotebookRuntimeTemplatesRequest.Builder clearReadMask()

Optional. Mask specifying which fields to read.

.google.protobuf.FieldMask read_mask = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ListNotebookRuntimeTemplatesRequest.Builder

clone()

public ListNotebookRuntimeTemplatesRequest.Builder clone()
Returns
Type Description
ListNotebookRuntimeTemplatesRequest.Builder
Overrides

getDefaultInstanceForType()

public ListNotebookRuntimeTemplatesRequest getDefaultInstanceForType()
Returns
Type Description
ListNotebookRuntimeTemplatesRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getFilter()

public String getFilter()

Optional. An expression for filtering the results of the request. For field names both snake_case and camelCase are supported.

  • notebookRuntimeTemplate supports = and !=. notebookRuntimeTemplate represents the NotebookRuntimeTemplate ID, i.e. the last segment of the NotebookRuntimeTemplate's [resource name] [google.cloud.aiplatform.v1beta1.NotebookRuntimeTemplate.name].
  • display_name supports = and !=
  • labels supports general map functions that is:
    • labels.key=value - key:value equality
    • labels.key:* or labels:key - key existence
    • A key including a space must be quoted. labels."a key".
  • notebookRuntimeType supports = and !=. notebookRuntimeType enum: [USER_DEFINED, ONE_CLICK].

    Some examples:

  • notebookRuntimeTemplate=notebookRuntimeTemplate123

  • displayName="myDisplayName"
  • labels.myKey="myValue"
  • notebookRuntimeType=USER_DEFINED`

string filter = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The filter.

getFilterBytes()

public ByteString getFilterBytes()

Optional. An expression for filtering the results of the request. For field names both snake_case and camelCase are supported.

  • notebookRuntimeTemplate supports = and !=. notebookRuntimeTemplate represents the NotebookRuntimeTemplate ID, i.e. the last segment of the NotebookRuntimeTemplate's [resource name] [google.cloud.aiplatform.v1beta1.NotebookRuntimeTemplate.name].
  • display_name supports = and !=
  • labels supports general map functions that is:
    • labels.key=value - key:value equality
    • labels.key:* or labels:key - key existence
    • A key including a space must be quoted. labels."a key".
  • notebookRuntimeType supports = and !=. notebookRuntimeType enum: [USER_DEFINED, ONE_CLICK].

    Some examples:

  • notebookRuntimeTemplate=notebookRuntimeTemplate123

  • displayName="myDisplayName"
  • labels.myKey="myValue"
  • notebookRuntimeType=USER_DEFINED`

string filter = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for filter.

getOrderBy()

public String getOrderBy()

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.

string order_by = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The orderBy.

getOrderByBytes()

public ByteString getOrderByBytes()

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.

string order_by = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for orderBy.

getPageSize()

public int getPageSize()

Optional. The standard list page size.

int32 page_size = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The pageSize.

getPageToken()

public String getPageToken()

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

string page_token = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The pageToken.

getPageTokenBytes()

public ByteString getPageTokenBytes()

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

string page_token = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for pageToken.

getParent()

public String getParent()

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

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The parent.

getParentBytes()

public ByteString getParentBytes()

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

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for parent.

getReadMask()

public FieldMask getReadMask()

Optional. Mask specifying which fields to read.

.google.protobuf.FieldMask read_mask = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
FieldMask

The readMask.

getReadMaskBuilder()

public FieldMask.Builder getReadMaskBuilder()

Optional. Mask specifying which fields to read.

.google.protobuf.FieldMask read_mask = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Builder

getReadMaskOrBuilder()

public FieldMaskOrBuilder getReadMaskOrBuilder()

Optional. Mask specifying which fields to read.

.google.protobuf.FieldMask read_mask = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
FieldMaskOrBuilder

hasReadMask()

public boolean hasReadMask()

Optional. Mask specifying which fields to read.

.google.protobuf.FieldMask read_mask = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the readMask field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(ListNotebookRuntimeTemplatesRequest other)

public ListNotebookRuntimeTemplatesRequest.Builder mergeFrom(ListNotebookRuntimeTemplatesRequest other)
Parameter
Name Description
other ListNotebookRuntimeTemplatesRequest
Returns
Type Description
ListNotebookRuntimeTemplatesRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public ListNotebookRuntimeTemplatesRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListNotebookRuntimeTemplatesRequest.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public ListNotebookRuntimeTemplatesRequest.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
ListNotebookRuntimeTemplatesRequest.Builder
Overrides

mergeReadMask(FieldMask value)

public ListNotebookRuntimeTemplatesRequest.Builder mergeReadMask(FieldMask value)

Optional. Mask specifying which fields to read.

.google.protobuf.FieldMask read_mask = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value FieldMask
Returns
Type Description
ListNotebookRuntimeTemplatesRequest.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final ListNotebookRuntimeTemplatesRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
ListNotebookRuntimeTemplatesRequest.Builder
Overrides

setField(Descriptors.FieldDescriptor field, Object value)

public ListNotebookRuntimeTemplatesRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
ListNotebookRuntimeTemplatesRequest.Builder
Overrides

setFilter(String value)

public ListNotebookRuntimeTemplatesRequest.Builder setFilter(String value)

Optional. An expression for filtering the results of the request. For field names both snake_case and camelCase are supported.

  • notebookRuntimeTemplate supports = and !=. notebookRuntimeTemplate represents the NotebookRuntimeTemplate ID, i.e. the last segment of the NotebookRuntimeTemplate's [resource name] [google.cloud.aiplatform.v1beta1.NotebookRuntimeTemplate.name].
  • display_name supports = and !=
  • labels supports general map functions that is:
    • labels.key=value - key:value equality
    • labels.key:* or labels:key - key existence
    • A key including a space must be quoted. labels."a key".
  • notebookRuntimeType supports = and !=. notebookRuntimeType enum: [USER_DEFINED, ONE_CLICK].

    Some examples:

  • notebookRuntimeTemplate=notebookRuntimeTemplate123

  • displayName="myDisplayName"
  • labels.myKey="myValue"
  • notebookRuntimeType=USER_DEFINED`

string filter = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value String

The filter to set.

Returns
Type Description
ListNotebookRuntimeTemplatesRequest.Builder

This builder for chaining.

setFilterBytes(ByteString value)

public ListNotebookRuntimeTemplatesRequest.Builder setFilterBytes(ByteString value)

Optional. An expression for filtering the results of the request. For field names both snake_case and camelCase are supported.

  • notebookRuntimeTemplate supports = and !=. notebookRuntimeTemplate represents the NotebookRuntimeTemplate ID, i.e. the last segment of the NotebookRuntimeTemplate's [resource name] [google.cloud.aiplatform.v1beta1.NotebookRuntimeTemplate.name].
  • display_name supports = and !=
  • labels supports general map functions that is:
    • labels.key=value - key:value equality
    • labels.key:* or labels:key - key existence
    • A key including a space must be quoted. labels."a key".
  • notebookRuntimeType supports = and !=. notebookRuntimeType enum: [USER_DEFINED, ONE_CLICK].

    Some examples:

  • notebookRuntimeTemplate=notebookRuntimeTemplate123

  • displayName="myDisplayName"
  • labels.myKey="myValue"
  • notebookRuntimeType=USER_DEFINED`

string filter = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ByteString

The bytes for filter to set.

Returns
Type Description
ListNotebookRuntimeTemplatesRequest.Builder

This builder for chaining.

setOrderBy(String value)

public ListNotebookRuntimeTemplatesRequest.Builder setOrderBy(String value)

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.

string order_by = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value String

The orderBy to set.

Returns
Type Description
ListNotebookRuntimeTemplatesRequest.Builder

This builder for chaining.

setOrderByBytes(ByteString value)

public ListNotebookRuntimeTemplatesRequest.Builder setOrderByBytes(ByteString value)

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.

string order_by = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ByteString

The bytes for orderBy to set.

Returns
Type Description
ListNotebookRuntimeTemplatesRequest.Builder

This builder for chaining.

setPageSize(int value)

public ListNotebookRuntimeTemplatesRequest.Builder setPageSize(int value)

Optional. The standard list page size.

int32 page_size = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value int

The pageSize to set.

Returns
Type Description
ListNotebookRuntimeTemplatesRequest.Builder

This builder for chaining.

setPageToken(String value)

public ListNotebookRuntimeTemplatesRequest.Builder setPageToken(String value)

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

string page_token = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value String

The pageToken to set.

Returns
Type Description
ListNotebookRuntimeTemplatesRequest.Builder

This builder for chaining.

setPageTokenBytes(ByteString value)

public ListNotebookRuntimeTemplatesRequest.Builder setPageTokenBytes(ByteString value)

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

string page_token = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ByteString

The bytes for pageToken to set.

Returns
Type Description
ListNotebookRuntimeTemplatesRequest.Builder

This builder for chaining.

setParent(String value)

public ListNotebookRuntimeTemplatesRequest.Builder setParent(String value)

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

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value String

The parent to set.

Returns
Type Description
ListNotebookRuntimeTemplatesRequest.Builder

This builder for chaining.

setParentBytes(ByteString value)

public ListNotebookRuntimeTemplatesRequest.Builder setParentBytes(ByteString value)

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

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value ByteString

The bytes for parent to set.

Returns
Type Description
ListNotebookRuntimeTemplatesRequest.Builder

This builder for chaining.

setReadMask(FieldMask value)

public ListNotebookRuntimeTemplatesRequest.Builder setReadMask(FieldMask value)

Optional. Mask specifying which fields to read.

.google.protobuf.FieldMask read_mask = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value FieldMask
Returns
Type Description
ListNotebookRuntimeTemplatesRequest.Builder

setReadMask(FieldMask.Builder builderForValue)

public ListNotebookRuntimeTemplatesRequest.Builder setReadMask(FieldMask.Builder builderForValue)

Optional. Mask specifying which fields to read.

.google.protobuf.FieldMask read_mask = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
builderForValue Builder
Returns
Type Description
ListNotebookRuntimeTemplatesRequest.Builder

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public ListNotebookRuntimeTemplatesRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
ListNotebookRuntimeTemplatesRequest.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final ListNotebookRuntimeTemplatesRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
ListNotebookRuntimeTemplatesRequest.Builder
Overrides