Class ListNotebookExecutionJobsRequest (3.48.0)

public final class ListNotebookExecutionJobsRequest extends GeneratedMessageV3 implements ListNotebookExecutionJobsRequestOrBuilder

Request message for [NotebookService.ListNotebookExecutionJobs]

Protobuf type google.cloud.aiplatform.v1beta1.ListNotebookExecutionJobsRequest

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > ListNotebookExecutionJobsRequest

Static Fields

FILTER_FIELD_NUMBER

public static final int FILTER_FIELD_NUMBER
Field Value
Type Description
int

ORDER_BY_FIELD_NUMBER

public static final int ORDER_BY_FIELD_NUMBER
Field Value
Type Description
int

PAGE_SIZE_FIELD_NUMBER

public static final int PAGE_SIZE_FIELD_NUMBER
Field Value
Type Description
int

PAGE_TOKEN_FIELD_NUMBER

public static final int PAGE_TOKEN_FIELD_NUMBER
Field Value
Type Description
int

PARENT_FIELD_NUMBER

public static final int PARENT_FIELD_NUMBER
Field Value
Type Description
int

VIEW_FIELD_NUMBER

public static final int VIEW_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static ListNotebookExecutionJobsRequest getDefaultInstance()
Returns
Type Description
ListNotebookExecutionJobsRequest

getDescriptor()

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

newBuilder()

public static ListNotebookExecutionJobsRequest.Builder newBuilder()
Returns
Type Description
ListNotebookExecutionJobsRequest.Builder

newBuilder(ListNotebookExecutionJobsRequest prototype)

public static ListNotebookExecutionJobsRequest.Builder newBuilder(ListNotebookExecutionJobsRequest prototype)
Parameter
Name Description
prototype ListNotebookExecutionJobsRequest
Returns
Type Description
ListNotebookExecutionJobsRequest.Builder

parseDelimitedFrom(InputStream input)

public static ListNotebookExecutionJobsRequest parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ListNotebookExecutionJobsRequest
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ListNotebookExecutionJobsRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListNotebookExecutionJobsRequest
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static ListNotebookExecutionJobsRequest parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
ListNotebookExecutionJobsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static ListNotebookExecutionJobsRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListNotebookExecutionJobsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static ListNotebookExecutionJobsRequest parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
ListNotebookExecutionJobsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static ListNotebookExecutionJobsRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListNotebookExecutionJobsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static ListNotebookExecutionJobsRequest parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
ListNotebookExecutionJobsRequest
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static ListNotebookExecutionJobsRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListNotebookExecutionJobsRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static ListNotebookExecutionJobsRequest parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ListNotebookExecutionJobsRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ListNotebookExecutionJobsRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListNotebookExecutionJobsRequest
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static ListNotebookExecutionJobsRequest parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
ListNotebookExecutionJobsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static ListNotebookExecutionJobsRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListNotebookExecutionJobsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<ListNotebookExecutionJobsRequest> parser()
Returns
Type Description
Parser<ListNotebookExecutionJobsRequest>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public ListNotebookExecutionJobsRequest getDefaultInstanceForType()
Returns
Type Description
ListNotebookExecutionJobsRequest

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.

getParserForType()

public Parser<ListNotebookExecutionJobsRequest> getParserForType()
Returns
Type Description
Parser<ListNotebookExecutionJobsRequest>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getView()

public NotebookExecutionJobView getView()

Optional. The NotebookExecutionJob view. Defaults to BASIC.

.google.cloud.aiplatform.v1beta1.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.v1beta1.NotebookExecutionJobView view = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The enum numeric value on the wire for view.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public ListNotebookExecutionJobsRequest.Builder newBuilderForType()
Returns
Type Description
ListNotebookExecutionJobsRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected ListNotebookExecutionJobsRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
ListNotebookExecutionJobsRequest.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public ListNotebookExecutionJobsRequest.Builder toBuilder()
Returns
Type Description
ListNotebookExecutionJobsRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException