public final class ListModelsRequest extends GeneratedMessageV3 implements ListModelsRequestOrBuilder
Request message for
ModelService.ListModels.
Protobuf type google.cloud.aiplatform.v1.ListModelsRequest
Static Fields
public static final int FILTER_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
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 | |
public static final int PARENT_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
public static final int READ_MASK_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
Static Methods
public static ListModelsRequest getDefaultInstance()
public static final Descriptors.Descriptor getDescriptor()
public static ListModelsRequest.Builder newBuilder()
public static ListModelsRequest.Builder newBuilder(ListModelsRequest prototype)
public static ListModelsRequest parseDelimitedFrom(InputStream input)
public static ListModelsRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static ListModelsRequest parseFrom(byte[] data)
| Parameter |
|---|
| Name | Description |
data | byte[]
|
public static ListModelsRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static ListModelsRequest parseFrom(ByteString data)
public static ListModelsRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static ListModelsRequest parseFrom(CodedInputStream input)
public static ListModelsRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static ListModelsRequest parseFrom(InputStream input)
public static ListModelsRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static ListModelsRequest parseFrom(ByteBuffer data)
public static ListModelsRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Parser<ListModelsRequest> parser()
Methods
public boolean equals(Object obj)
| Parameter |
|---|
| Name | Description |
obj | Object
|
Overrides
public ListModelsRequest getDefaultInstanceForType()
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 equalitylabels.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 |
|---|
| Type | Description |
String | The filter.
|
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 equalitylabels.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 |
|---|
| Type | Description |
ByteString | The bytes for filter.
|
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_namecreate_timeupdate_time
Example: display_name, create_time desc.
string order_by = 6;
| Returns |
|---|
| Type | Description |
String | The orderBy.
|
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_namecreate_timeupdate_time
Example: display_name, create_time desc.
string order_by = 6;
| Returns |
|---|
| Type | Description |
ByteString | The bytes for orderBy.
|
getPageSize()
The standard list page size.
int32 page_size = 3;
| Returns |
|---|
| Type | Description |
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 |
|---|
| Type | Description |
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 |
|---|
| Type | Description |
ByteString | The bytes for pageToken.
|
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 |
|---|
| Type | Description |
String | The parent.
|
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 |
|---|
| Type | Description |
ByteString | The bytes for parent.
|
public Parser<ListModelsRequest> getParserForType()
Overrides
public FieldMask getReadMask()
Mask specifying which fields to read.
.google.protobuf.FieldMask read_mask = 5;
public FieldMaskOrBuilder getReadMaskOrBuilder()
Mask specifying which fields to read.
.google.protobuf.FieldMask read_mask = 5;
public int getSerializedSize()
| Returns |
|---|
| Type | Description |
int | |
Overrides
public final UnknownFieldSet getUnknownFields()
Overrides
public boolean hasReadMask()
Mask specifying which fields to read.
.google.protobuf.FieldMask read_mask = 5;
| Returns |
|---|
| Type | Description |
boolean | Whether the readMask field is set.
|
| Returns |
|---|
| Type | Description |
int | |
Overrides
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
public final boolean isInitialized()
Overrides
public ListModelsRequest.Builder newBuilderForType()
protected ListModelsRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Overrides
public ListModelsRequest.Builder toBuilder()
public void writeTo(CodedOutputStream output)
Overrides
