Interface ListModelsRequestOrBuilder (3.56.0)

public interface ListModelsRequestOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getFilter()

public abstract 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".
  • base_model_name only supports =

    Some examples:

  • model=1234

  • displayName="myDisplayName"
  • labels.myKey="myValue"
  • baseModelName="text-bison"`

string filter = 2;

Returns
Type Description
String

The filter.

getFilterBytes()

public abstract 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".
  • base_model_name only supports =

    Some examples:

  • model=1234

  • displayName="myDisplayName"
  • labels.myKey="myValue"
  • baseModelName="text-bison"`

string filter = 2;

Returns
Type Description
ByteString

The bytes for filter.

getPageSize()

public abstract int getPageSize()

The standard list page size.

int32 page_size = 3;

Returns
Type Description
int

The pageSize.

getPageToken()

public abstract 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
Type Description
String

The pageToken.

getPageTokenBytes()

public abstract 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
Type Description
ByteString

The bytes for pageToken.

getParent()

public abstract 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
Type Description
String

The parent.

getParentBytes()

public abstract 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
Type Description
ByteString

The bytes for parent.

getReadMask()

public abstract FieldMask getReadMask()

Mask specifying which fields to read.

.google.protobuf.FieldMask read_mask = 5;

Returns
Type Description
FieldMask

The readMask.

getReadMaskOrBuilder()

public abstract FieldMaskOrBuilder getReadMaskOrBuilder()

Mask specifying which fields to read.

.google.protobuf.FieldMask read_mask = 5;

Returns
Type Description
FieldMaskOrBuilder

hasReadMask()

public abstract boolean hasReadMask()

Mask specifying which fields to read.

.google.protobuf.FieldMask read_mask = 5;

Returns
Type Description
boolean

Whether the readMask field is set.