Class ListInstancesRequest.Builder (1.32.0)

public static final class ListInstancesRequest.Builder extends GeneratedMessageV3.Builder<ListInstancesRequest.Builder> implements ListInstancesRequestOrBuilder

Request for listing notebook instances.

Protobuf type google.cloud.notebooks.v2.ListInstancesRequest

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public ListInstancesRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
ListInstancesRequest.Builder
Overrides

build()

public ListInstancesRequest build()
Returns
TypeDescription
ListInstancesRequest

buildPartial()

public ListInstancesRequest buildPartial()
Returns
TypeDescription
ListInstancesRequest

clear()

public ListInstancesRequest.Builder clear()
Returns
TypeDescription
ListInstancesRequest.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public ListInstancesRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
ListInstancesRequest.Builder
Overrides

clearFilter()

public ListInstancesRequest.Builder clearFilter()

Optional. List filter.

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

Returns
TypeDescription
ListInstancesRequest.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public ListInstancesRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
ListInstancesRequest.Builder
Overrides

clearOrderBy()

public ListInstancesRequest.Builder clearOrderBy()

Optional. Sort results. Supported values are "name", "name desc" or "" (unsorted).

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

Returns
TypeDescription
ListInstancesRequest.Builder

This builder for chaining.

clearPageSize()

public ListInstancesRequest.Builder clearPageSize()

Optional. Maximum return size of the list call.

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

Returns
TypeDescription
ListInstancesRequest.Builder

This builder for chaining.

clearPageToken()

public ListInstancesRequest.Builder clearPageToken()

Optional. A previous returned page token that can be used to continue listing from the last result.

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

Returns
TypeDescription
ListInstancesRequest.Builder

This builder for chaining.

clearParent()

public ListInstancesRequest.Builder clearParent()

Required. Format: parent=projects/{project_id}/locations/{location}

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

Returns
TypeDescription
ListInstancesRequest.Builder

This builder for chaining.

clone()

public ListInstancesRequest.Builder clone()
Returns
TypeDescription
ListInstancesRequest.Builder
Overrides

getDefaultInstanceForType()

public ListInstancesRequest getDefaultInstanceForType()
Returns
TypeDescription
ListInstancesRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getFilter()

public String getFilter()

Optional. List filter.

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

Returns
TypeDescription
String

The filter.

getFilterBytes()

public ByteString getFilterBytes()

Optional. List filter.

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

Returns
TypeDescription
ByteString

The bytes for filter.

getOrderBy()

public String getOrderBy()

Optional. Sort results. Supported values are "name", "name desc" or "" (unsorted).

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

Returns
TypeDescription
String

The orderBy.

getOrderByBytes()

public ByteString getOrderByBytes()

Optional. Sort results. Supported values are "name", "name desc" or "" (unsorted).

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

Returns
TypeDescription
ByteString

The bytes for orderBy.

getPageSize()

public int getPageSize()

Optional. Maximum return size of the list call.

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

Returns
TypeDescription
int

The pageSize.

getPageToken()

public String getPageToken()

Optional. A previous returned page token that can be used to continue listing from the last result.

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

Returns
TypeDescription
String

The pageToken.

getPageTokenBytes()

public ByteString getPageTokenBytes()

Optional. A previous returned page token that can be used to continue listing from the last result.

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

Returns
TypeDescription
ByteString

The bytes for pageToken.

getParent()

public String getParent()

Required. Format: parent=projects/{project_id}/locations/{location}

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

Returns
TypeDescription
String

The parent.

getParentBytes()

public ByteString getParentBytes()

Required. Format: parent=projects/{project_id}/locations/{location}

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

Returns
TypeDescription
ByteString

The bytes for parent.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(ListInstancesRequest other)

public ListInstancesRequest.Builder mergeFrom(ListInstancesRequest other)
Parameter
NameDescription
otherListInstancesRequest
Returns
TypeDescription
ListInstancesRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public ListInstancesRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ListInstancesRequest.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public ListInstancesRequest.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
ListInstancesRequest.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final ListInstancesRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
ListInstancesRequest.Builder
Overrides

setField(Descriptors.FieldDescriptor field, Object value)

public ListInstancesRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
ListInstancesRequest.Builder
Overrides

setFilter(String value)

public ListInstancesRequest.Builder setFilter(String value)

Optional. List filter.

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

Parameter
NameDescription
valueString

The filter to set.

Returns
TypeDescription
ListInstancesRequest.Builder

This builder for chaining.

setFilterBytes(ByteString value)

public ListInstancesRequest.Builder setFilterBytes(ByteString value)

Optional. List filter.

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

Parameter
NameDescription
valueByteString

The bytes for filter to set.

Returns
TypeDescription
ListInstancesRequest.Builder

This builder for chaining.

setOrderBy(String value)

public ListInstancesRequest.Builder setOrderBy(String value)

Optional. Sort results. Supported values are "name", "name desc" or "" (unsorted).

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

Parameter
NameDescription
valueString

The orderBy to set.

Returns
TypeDescription
ListInstancesRequest.Builder

This builder for chaining.

setOrderByBytes(ByteString value)

public ListInstancesRequest.Builder setOrderByBytes(ByteString value)

Optional. Sort results. Supported values are "name", "name desc" or "" (unsorted).

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

Parameter
NameDescription
valueByteString

The bytes for orderBy to set.

Returns
TypeDescription
ListInstancesRequest.Builder

This builder for chaining.

setPageSize(int value)

public ListInstancesRequest.Builder setPageSize(int value)

Optional. Maximum return size of the list call.

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

Parameter
NameDescription
valueint

The pageSize to set.

Returns
TypeDescription
ListInstancesRequest.Builder

This builder for chaining.

setPageToken(String value)

public ListInstancesRequest.Builder setPageToken(String value)

Optional. A previous returned page token that can be used to continue listing from the last result.

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

Parameter
NameDescription
valueString

The pageToken to set.

Returns
TypeDescription
ListInstancesRequest.Builder

This builder for chaining.

setPageTokenBytes(ByteString value)

public ListInstancesRequest.Builder setPageTokenBytes(ByteString value)

Optional. A previous returned page token that can be used to continue listing from the last result.

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

Parameter
NameDescription
valueByteString

The bytes for pageToken to set.

Returns
TypeDescription
ListInstancesRequest.Builder

This builder for chaining.

setParent(String value)

public ListInstancesRequest.Builder setParent(String value)

Required. Format: parent=projects/{project_id}/locations/{location}

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

Parameter
NameDescription
valueString

The parent to set.

Returns
TypeDescription
ListInstancesRequest.Builder

This builder for chaining.

setParentBytes(ByteString value)

public ListInstancesRequest.Builder setParentBytes(ByteString value)

Required. Format: parent=projects/{project_id}/locations/{location}

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

Parameter
NameDescription
valueByteString

The bytes for parent to set.

Returns
TypeDescription
ListInstancesRequest.Builder

This builder for chaining.

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

public ListInstancesRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
ListInstancesRequest.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final ListInstancesRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
ListInstancesRequest.Builder
Overrides