Class ListModelsRequest.Builder (3.35.0)

public static final class ListModelsRequest.Builder extends GeneratedMessageV3.Builder<ListModelsRequest.Builder> implements ListModelsRequestOrBuilder

Request message for ModelService.ListModels.

Protobuf type google.cloud.aiplatform.v1.ListModelsRequest

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public ListModelsRequest build()
Returns
TypeDescription
ListModelsRequest

buildPartial()

public ListModelsRequest buildPartial()
Returns
TypeDescription
ListModelsRequest

clear()

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

clearField(Descriptors.FieldDescriptor field)

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

clearFilter()

public ListModelsRequest.Builder clearFilter()

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

  • model supports = and !=. model represents the Model ID, i.e. the last segment of the Model's resource 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".

    Some examples:

  • model=1234

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

string filter = 2;

Returns
TypeDescription
ListModelsRequest.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

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

clearOrderBy()

public ListModelsRequest.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:

  • display_name
  • create_time
  • update_time

    Example: display_name, create_time desc.

string order_by = 6;

Returns
TypeDescription
ListModelsRequest.Builder

This builder for chaining.

clearPageSize()

public ListModelsRequest.Builder clearPageSize()

The standard list page size.

int32 page_size = 3;

Returns
TypeDescription
ListModelsRequest.Builder

This builder for chaining.

clearPageToken()

public ListModelsRequest.Builder clearPageToken()

The standard list page token. Typically obtained via ListModelsResponse.next_page_token of the previous ModelService.ListModels call.

string page_token = 4;

Returns
TypeDescription
ListModelsRequest.Builder

This builder for chaining.

clearParent()

public ListModelsRequest.Builder clearParent()

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

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

Returns
TypeDescription
ListModelsRequest.Builder

This builder for chaining.

clearReadMask()

public ListModelsRequest.Builder clearReadMask()

Mask specifying which fields to read.

.google.protobuf.FieldMask read_mask = 5;

Returns
TypeDescription
ListModelsRequest.Builder

clone()

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

getDefaultInstanceForType()

public ListModelsRequest getDefaultInstanceForType()
Returns
TypeDescription
ListModelsRequest

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.

  • model supports = and !=. model represents the Model ID, i.e. the last segment of the Model's resource 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".

    Some examples:

  • model=1234

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

string filter = 2;

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.

  • model supports = and !=. model represents the Model ID, i.e. the last segment of the Model's resource 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".

    Some examples:

  • model=1234

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

string filter = 2;

Returns
TypeDescription
ByteString

The bytes for filter.

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:

  • display_name
  • create_time
  • update_time

    Example: display_name, 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:

  • display_name
  • create_time
  • update_time

    Example: display_name, 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 = 3;

Returns
TypeDescription
int

The pageSize.

getPageToken()

public String getPageToken()

The standard list page token. Typically obtained via ListModelsResponse.next_page_token of the previous ModelService.ListModels call.

string page_token = 4;

Returns
TypeDescription
String

The pageToken.

getPageTokenBytes()

public ByteString getPageTokenBytes()

The standard list page token. Typically obtained via ListModelsResponse.next_page_token of the previous ModelService.ListModels call.

string page_token = 4;

Returns
TypeDescription
ByteString

The bytes for pageToken.

getParent()

public String getParent()

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

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

Returns
TypeDescription
String

The parent.

getParentBytes()

public ByteString getParentBytes()

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

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

Returns
TypeDescription
ByteString

The bytes for parent.

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(ListModelsRequest other)

public ListModelsRequest.Builder mergeFrom(ListModelsRequest other)
Parameter
NameDescription
otherListModelsRequest
Returns
TypeDescription
ListModelsRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeReadMask(FieldMask value)

public ListModelsRequest.Builder mergeReadMask(FieldMask value)

Mask specifying which fields to read.

.google.protobuf.FieldMask read_mask = 5;

Parameter
NameDescription
valueFieldMask
Returns
TypeDescription
ListModelsRequest.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

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

setField(Descriptors.FieldDescriptor field, Object value)

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

setFilter(String value)

public ListModelsRequest.Builder setFilter(String value)

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

  • model supports = and !=. model represents the Model ID, i.e. the last segment of the Model's resource 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".

    Some examples:

  • model=1234

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

string filter = 2;

Parameter
NameDescription
valueString

The filter to set.

Returns
TypeDescription
ListModelsRequest.Builder

This builder for chaining.

setFilterBytes(ByteString value)

public ListModelsRequest.Builder setFilterBytes(ByteString value)

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

  • model supports = and !=. model represents the Model ID, i.e. the last segment of the Model's resource 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".

    Some examples:

  • model=1234

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

string filter = 2;

Parameter
NameDescription
valueByteString

The bytes for filter to set.

Returns
TypeDescription
ListModelsRequest.Builder

This builder for chaining.

setOrderBy(String value)

public ListModelsRequest.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:

  • display_name
  • create_time
  • update_time

    Example: display_name, create_time desc.

string order_by = 6;

Parameter
NameDescription
valueString

The orderBy to set.

Returns
TypeDescription
ListModelsRequest.Builder

This builder for chaining.

setOrderByBytes(ByteString value)

public ListModelsRequest.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:

  • display_name
  • create_time
  • update_time

    Example: display_name, create_time desc.

string order_by = 6;

Parameter
NameDescription
valueByteString

The bytes for orderBy to set.

Returns
TypeDescription
ListModelsRequest.Builder

This builder for chaining.

setPageSize(int value)

public ListModelsRequest.Builder setPageSize(int value)

The standard list page size.

int32 page_size = 3;

Parameter
NameDescription
valueint

The pageSize to set.

Returns
TypeDescription
ListModelsRequest.Builder

This builder for chaining.

setPageToken(String value)

public ListModelsRequest.Builder setPageToken(String value)

The standard list page token. Typically obtained via ListModelsResponse.next_page_token of the previous ModelService.ListModels call.

string page_token = 4;

Parameter
NameDescription
valueString

The pageToken to set.

Returns
TypeDescription
ListModelsRequest.Builder

This builder for chaining.

setPageTokenBytes(ByteString value)

public ListModelsRequest.Builder setPageTokenBytes(ByteString value)

The standard list page token. Typically obtained via ListModelsResponse.next_page_token of the previous ModelService.ListModels call.

string page_token = 4;

Parameter
NameDescription
valueByteString

The bytes for pageToken to set.

Returns
TypeDescription
ListModelsRequest.Builder

This builder for chaining.

setParent(String value)

public ListModelsRequest.Builder setParent(String value)

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

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

Parameter
NameDescription
valueString

The parent to set.

Returns
TypeDescription
ListModelsRequest.Builder

This builder for chaining.

setParentBytes(ByteString value)

public ListModelsRequest.Builder setParentBytes(ByteString value)

Required. The resource name of the Location to list the Models from. Format: projects/{project}/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
ListModelsRequest.Builder

This builder for chaining.

setReadMask(FieldMask value)

public ListModelsRequest.Builder setReadMask(FieldMask value)

Mask specifying which fields to read.

.google.protobuf.FieldMask read_mask = 5;

Parameter
NameDescription
valueFieldMask
Returns
TypeDescription
ListModelsRequest.Builder

setReadMask(FieldMask.Builder builderForValue)

public ListModelsRequest.Builder setReadMask(FieldMask.Builder builderForValue)

Mask specifying which fields to read.

.google.protobuf.FieldMask read_mask = 5;

Parameter
NameDescription
builderForValueBuilder
Returns
TypeDescription
ListModelsRequest.Builder

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

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

setUnknownFields(UnknownFieldSet unknownFields)

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