Class ListNotebookExecutionJobsRequest.Builder (3.50.0)

public static final class ListNotebookExecutionJobsRequest.Builder extends GeneratedMessageV3.Builder<ListNotebookExecutionJobsRequest.Builder> implements ListNotebookExecutionJobsRequestOrBuilder

Request message for [NotebookService.ListNotebookExecutionJobs]

Protobuf type google.cloud.aiplatform.v1.ListNotebookExecutionJobsRequest

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public ListNotebookExecutionJobsRequest build()
Returns
Type Description
ListNotebookExecutionJobsRequest

buildPartial()

public ListNotebookExecutionJobsRequest buildPartial()
Returns
Type Description
ListNotebookExecutionJobsRequest

clear()

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

clearField(Descriptors.FieldDescriptor field)

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

clearFilter()

public ListNotebookExecutionJobsRequest.Builder clearFilter()

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

  • notebookExecutionJob supports = and !=. notebookExecutionJob represents the NotebookExecutionJob ID.
  • displayName supports = and != and regex.
  • schedule supports = and != and regex.

    Some examples:

  • notebookExecutionJob="123"
  • notebookExecutionJob="my-execution-job"
  • displayName="myDisplayName" and displayName=~"myDisplayNameRegex"

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

Returns
Type Description
ListNotebookExecutionJobsRequest.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

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

clearOrderBy()

public ListNotebookExecutionJobsRequest.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 = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ListNotebookExecutionJobsRequest.Builder

This builder for chaining.

clearPageSize()

public ListNotebookExecutionJobsRequest.Builder clearPageSize()

Optional. The standard list page size.

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

Returns
Type Description
ListNotebookExecutionJobsRequest.Builder

This builder for chaining.

clearPageToken()

public ListNotebookExecutionJobsRequest.Builder clearPageToken()

Optional. The standard list page token. Typically obtained via [ListNotebookExecutionJobs.next_page_token][] of the previous NotebookService.ListNotebookExecutionJobs call.

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

Returns
Type Description
ListNotebookExecutionJobsRequest.Builder

This builder for chaining.

clearParent()

public ListNotebookExecutionJobsRequest.Builder clearParent()

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

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

Returns
Type Description
ListNotebookExecutionJobsRequest.Builder

This builder for chaining.

clearView()

public ListNotebookExecutionJobsRequest.Builder clearView()

Optional. The NotebookExecutionJob view. Defaults to BASIC.

.google.cloud.aiplatform.v1.NotebookExecutionJobView view = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ListNotebookExecutionJobsRequest.Builder

This builder for chaining.

clone()

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

getDefaultInstanceForType()

public ListNotebookExecutionJobsRequest getDefaultInstanceForType()
Returns
Type Description
ListNotebookExecutionJobsRequest

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.

  • notebookExecutionJob supports = and !=. notebookExecutionJob represents the NotebookExecutionJob ID.
  • displayName supports = and != and regex.
  • schedule supports = and != and regex.

    Some examples:

  • notebookExecutionJob="123"
  • notebookExecutionJob="my-execution-job"
  • displayName="myDisplayName" and displayName=~"myDisplayNameRegex"

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.

  • notebookExecutionJob supports = and !=. notebookExecutionJob represents the NotebookExecutionJob ID.
  • displayName supports = and != and regex.
  • schedule supports = and != and regex.

    Some examples:

  • notebookExecutionJob="123"
  • notebookExecutionJob="my-execution-job"
  • displayName="myDisplayName" and displayName=~"myDisplayNameRegex"

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 = 5 [(.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 = 5 [(.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 [ListNotebookExecutionJobs.next_page_token][] of the previous NotebookService.ListNotebookExecutionJobs 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 [ListNotebookExecutionJobs.next_page_token][] of the previous NotebookService.ListNotebookExecutionJobs 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 NotebookExecutionJobs. 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 NotebookExecutionJobs. 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.

getView()

public NotebookExecutionJobView getView()

Optional. The NotebookExecutionJob view. Defaults to BASIC.

.google.cloud.aiplatform.v1.NotebookExecutionJobView view = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
NotebookExecutionJobView

The view.

getViewValue()

public int getViewValue()

Optional. The NotebookExecutionJob view. Defaults to BASIC.

.google.cloud.aiplatform.v1.NotebookExecutionJobView view = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The enum numeric value on the wire for view.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(ListNotebookExecutionJobsRequest other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeUnknownFields(UnknownFieldSet unknownFields)

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

setField(Descriptors.FieldDescriptor field, Object value)

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

setFilter(String value)

public ListNotebookExecutionJobsRequest.Builder setFilter(String value)

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

  • notebookExecutionJob supports = and !=. notebookExecutionJob represents the NotebookExecutionJob ID.
  • displayName supports = and != and regex.
  • schedule supports = and != and regex.

    Some examples:

  • notebookExecutionJob="123"
  • notebookExecutionJob="my-execution-job"
  • displayName="myDisplayName" and displayName=~"myDisplayNameRegex"

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

Parameter
Name Description
value String

The filter to set.

Returns
Type Description
ListNotebookExecutionJobsRequest.Builder

This builder for chaining.

setFilterBytes(ByteString value)

public ListNotebookExecutionJobsRequest.Builder setFilterBytes(ByteString value)

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

  • notebookExecutionJob supports = and !=. notebookExecutionJob represents the NotebookExecutionJob ID.
  • displayName supports = and != and regex.
  • schedule supports = and != and regex.

    Some examples:

  • notebookExecutionJob="123"
  • notebookExecutionJob="my-execution-job"
  • displayName="myDisplayName" and displayName=~"myDisplayNameRegex"

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

Parameter
Name Description
value ByteString

The bytes for filter to set.

Returns
Type Description
ListNotebookExecutionJobsRequest.Builder

This builder for chaining.

setOrderBy(String value)

public ListNotebookExecutionJobsRequest.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 = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value String

The orderBy to set.

Returns
Type Description
ListNotebookExecutionJobsRequest.Builder

This builder for chaining.

setOrderByBytes(ByteString value)

public ListNotebookExecutionJobsRequest.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 = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ByteString

The bytes for orderBy to set.

Returns
Type Description
ListNotebookExecutionJobsRequest.Builder

This builder for chaining.

setPageSize(int value)

public ListNotebookExecutionJobsRequest.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
ListNotebookExecutionJobsRequest.Builder

This builder for chaining.

setPageToken(String value)

public ListNotebookExecutionJobsRequest.Builder setPageToken(String value)

Optional. The standard list page token. Typically obtained via [ListNotebookExecutionJobs.next_page_token][] of the previous NotebookService.ListNotebookExecutionJobs call.

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

Parameter
Name Description
value String

The pageToken to set.

Returns
Type Description
ListNotebookExecutionJobsRequest.Builder

This builder for chaining.

setPageTokenBytes(ByteString value)

public ListNotebookExecutionJobsRequest.Builder setPageTokenBytes(ByteString value)

Optional. The standard list page token. Typically obtained via [ListNotebookExecutionJobs.next_page_token][] of the previous NotebookService.ListNotebookExecutionJobs call.

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

Parameter
Name Description
value ByteString

The bytes for pageToken to set.

Returns
Type Description
ListNotebookExecutionJobsRequest.Builder

This builder for chaining.

setParent(String value)

public ListNotebookExecutionJobsRequest.Builder setParent(String value)

Required. The resource name of the Location from which to list the NotebookExecutionJobs. 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
ListNotebookExecutionJobsRequest.Builder

This builder for chaining.

setParentBytes(ByteString value)

public ListNotebookExecutionJobsRequest.Builder setParentBytes(ByteString value)

Required. The resource name of the Location from which to list the NotebookExecutionJobs. 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
ListNotebookExecutionJobsRequest.Builder

This builder for chaining.

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

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

setUnknownFields(UnknownFieldSet unknownFields)

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

setView(NotebookExecutionJobView value)

public ListNotebookExecutionJobsRequest.Builder setView(NotebookExecutionJobView value)

Optional. The NotebookExecutionJob view. Defaults to BASIC.

.google.cloud.aiplatform.v1.NotebookExecutionJobView view = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value NotebookExecutionJobView

The view to set.

Returns
Type Description
ListNotebookExecutionJobsRequest.Builder

This builder for chaining.

setViewValue(int value)

public ListNotebookExecutionJobsRequest.Builder setViewValue(int value)

Optional. The NotebookExecutionJob view. Defaults to BASIC.

.google.cloud.aiplatform.v1.NotebookExecutionJobView view = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value int

The enum numeric value on the wire for view to set.

Returns
Type Description
ListNotebookExecutionJobsRequest.Builder

This builder for chaining.