Class ListModelVersionsRequest.Builder (3.25.0)

public static final class ListModelVersionsRequest.Builder extends GeneratedMessageV3.Builder<ListModelVersionsRequest.Builder> implements ListModelVersionsRequestOrBuilder

Request message for ModelService.ListModelVersions.

Protobuf type google.cloud.aiplatform.v1.ListModelVersionsRequest

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public ListModelVersionsRequest build()
Returns
TypeDescription
ListModelVersionsRequest

buildPartial()

public ListModelVersionsRequest buildPartial()
Returns
TypeDescription
ListModelVersionsRequest

clear()

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

clearField(Descriptors.FieldDescriptor field)

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

clearFilter()

public ListModelVersionsRequest.Builder clearFilter()

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

  • 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".

    Some examples:

  • labels.myKey="myValue"`

string filter = 4;

Returns
TypeDescription
ListModelVersionsRequest.Builder

This builder for chaining.

clearName()

public ListModelVersionsRequest.Builder clearName()

Required. The name of the model to list versions for.

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

Returns
TypeDescription
ListModelVersionsRequest.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

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

clearOrderBy()

public ListModelVersionsRequest.Builder clearOrderBy()

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

  • create_time
  • update_time

    Example: update_time asc, create_time desc.

string order_by = 6;

Returns
TypeDescription
ListModelVersionsRequest.Builder

This builder for chaining.

clearPageSize()

public ListModelVersionsRequest.Builder clearPageSize()

The standard list page size.

int32 page_size = 2;

Returns
TypeDescription
ListModelVersionsRequest.Builder

This builder for chaining.

clearPageToken()

public ListModelVersionsRequest.Builder clearPageToken()

The standard list page token. Typically obtained via next_page_token of the previous ListModelVersions call.

string page_token = 3;

Returns
TypeDescription
ListModelVersionsRequest.Builder

This builder for chaining.

clearReadMask()

public ListModelVersionsRequest.Builder clearReadMask()

Mask specifying which fields to read.

.google.protobuf.FieldMask read_mask = 5;

Returns
TypeDescription
ListModelVersionsRequest.Builder

clone()

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

getDefaultInstanceForType()

public ListModelVersionsRequest getDefaultInstanceForType()
Returns
TypeDescription
ListModelVersionsRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getFilter()

public String getFilter()

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

  • 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".

    Some examples:

  • labels.myKey="myValue"`

string filter = 4;

Returns
TypeDescription
String

The filter.

getFilterBytes()

public ByteString getFilterBytes()

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

  • 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".

    Some examples:

  • labels.myKey="myValue"`

string filter = 4;

Returns
TypeDescription
ByteString

The bytes for filter.

getName()

public String getName()

Required. The name of the model to list versions for.

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

Returns
TypeDescription
String

The name.

getNameBytes()

public ByteString getNameBytes()

Required. The name of the model to list versions for.

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

Returns
TypeDescription
ByteString

The bytes for name.

getOrderBy()

public String getOrderBy()

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

  • create_time
  • update_time

    Example: update_time asc, create_time desc.

string order_by = 6;

Returns
TypeDescription
String

The orderBy.

getOrderByBytes()

public ByteString getOrderByBytes()

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

  • create_time
  • update_time

    Example: update_time asc, create_time desc.

string order_by = 6;

Returns
TypeDescription
ByteString

The bytes for orderBy.

getPageSize()

public int getPageSize()

The standard list page size.

int32 page_size = 2;

Returns
TypeDescription
int

The pageSize.

getPageToken()

public String getPageToken()

The standard list page token. Typically obtained via next_page_token of the previous ListModelVersions call.

string page_token = 3;

Returns
TypeDescription
String

The pageToken.

getPageTokenBytes()

public ByteString getPageTokenBytes()

The standard list page token. Typically obtained via next_page_token of the previous ListModelVersions call.

string page_token = 3;

Returns
TypeDescription
ByteString

The bytes for pageToken.

getReadMask()

public FieldMask getReadMask()

Mask specifying which fields to read.

.google.protobuf.FieldMask read_mask = 5;

Returns
TypeDescription
FieldMask

The readMask.

getReadMaskBuilder()

public FieldMask.Builder getReadMaskBuilder()

Mask specifying which fields to read.

.google.protobuf.FieldMask read_mask = 5;

Returns
TypeDescription
Builder

getReadMaskOrBuilder()

public FieldMaskOrBuilder getReadMaskOrBuilder()

Mask specifying which fields to read.

.google.protobuf.FieldMask read_mask = 5;

Returns
TypeDescription
FieldMaskOrBuilder

hasReadMask()

public boolean hasReadMask()

Mask specifying which fields to read.

.google.protobuf.FieldMask read_mask = 5;

Returns
TypeDescription
boolean

Whether the readMask field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(ListModelVersionsRequest other)

public ListModelVersionsRequest.Builder mergeFrom(ListModelVersionsRequest other)
Parameter
NameDescription
otherListModelVersionsRequest
Returns
TypeDescription
ListModelVersionsRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeReadMask(FieldMask value)

public ListModelVersionsRequest.Builder mergeReadMask(FieldMask value)

Mask specifying which fields to read.

.google.protobuf.FieldMask read_mask = 5;

Parameter
NameDescription
valueFieldMask
Returns
TypeDescription
ListModelVersionsRequest.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

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

setField(Descriptors.FieldDescriptor field, Object value)

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

setFilter(String value)

public ListModelVersionsRequest.Builder setFilter(String value)

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

  • 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".

    Some examples:

  • labels.myKey="myValue"`

string filter = 4;

Parameter
NameDescription
valueString

The filter to set.

Returns
TypeDescription
ListModelVersionsRequest.Builder

This builder for chaining.

setFilterBytes(ByteString value)

public ListModelVersionsRequest.Builder setFilterBytes(ByteString value)

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

  • 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".

    Some examples:

  • labels.myKey="myValue"`

string filter = 4;

Parameter
NameDescription
valueByteString

The bytes for filter to set.

Returns
TypeDescription
ListModelVersionsRequest.Builder

This builder for chaining.

setName(String value)

public ListModelVersionsRequest.Builder setName(String value)

Required. The name of the model to list versions for.

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

Parameter
NameDescription
valueString

The name to set.

Returns
TypeDescription
ListModelVersionsRequest.Builder

This builder for chaining.

setNameBytes(ByteString value)

public ListModelVersionsRequest.Builder setNameBytes(ByteString value)

Required. The name of the model to list versions for.

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

Parameter
NameDescription
valueByteString

The bytes for name to set.

Returns
TypeDescription
ListModelVersionsRequest.Builder

This builder for chaining.

setOrderBy(String value)

public ListModelVersionsRequest.Builder setOrderBy(String value)

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

  • create_time
  • update_time

    Example: update_time asc, create_time desc.

string order_by = 6;

Parameter
NameDescription
valueString

The orderBy to set.

Returns
TypeDescription
ListModelVersionsRequest.Builder

This builder for chaining.

setOrderByBytes(ByteString value)

public ListModelVersionsRequest.Builder setOrderByBytes(ByteString value)

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

  • create_time
  • update_time

    Example: update_time asc, create_time desc.

string order_by = 6;

Parameter
NameDescription
valueByteString

The bytes for orderBy to set.

Returns
TypeDescription
ListModelVersionsRequest.Builder

This builder for chaining.

setPageSize(int value)

public ListModelVersionsRequest.Builder setPageSize(int value)

The standard list page size.

int32 page_size = 2;

Parameter
NameDescription
valueint

The pageSize to set.

Returns
TypeDescription
ListModelVersionsRequest.Builder

This builder for chaining.

setPageToken(String value)

public ListModelVersionsRequest.Builder setPageToken(String value)

The standard list page token. Typically obtained via next_page_token of the previous ListModelVersions call.

string page_token = 3;

Parameter
NameDescription
valueString

The pageToken to set.

Returns
TypeDescription
ListModelVersionsRequest.Builder

This builder for chaining.

setPageTokenBytes(ByteString value)

public ListModelVersionsRequest.Builder setPageTokenBytes(ByteString value)

The standard list page token. Typically obtained via next_page_token of the previous ListModelVersions call.

string page_token = 3;

Parameter
NameDescription
valueByteString

The bytes for pageToken to set.

Returns
TypeDescription
ListModelVersionsRequest.Builder

This builder for chaining.

setReadMask(FieldMask value)

public ListModelVersionsRequest.Builder setReadMask(FieldMask value)

Mask specifying which fields to read.

.google.protobuf.FieldMask read_mask = 5;

Parameter
NameDescription
valueFieldMask
Returns
TypeDescription
ListModelVersionsRequest.Builder

setReadMask(FieldMask.Builder builderForValue)

public ListModelVersionsRequest.Builder setReadMask(FieldMask.Builder builderForValue)

Mask specifying which fields to read.

.google.protobuf.FieldMask read_mask = 5;

Parameter
NameDescription
builderForValueBuilder
Returns
TypeDescription
ListModelVersionsRequest.Builder

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

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

setUnknownFields(UnknownFieldSet unknownFields)

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