public final class ListModelsRequest extends GeneratedMessageV3 implements ListModelsRequestOrBuilder
Request message for ModelService.ListModels.
Protobuf type google.cloud.aiplatform.v1beta1.ListModelsRequest
Static Fields
public static final int FILTER_FIELD_NUMBER
Field Value
PAGE_SIZE_FIELD_NUMBER
public static final int PAGE_SIZE_FIELD_NUMBER
Field Value
PAGE_TOKEN_FIELD_NUMBER
public static final int PAGE_TOKEN_FIELD_NUMBER
Field Value
public static final int PARENT_FIELD_NUMBER
Field Value
public static final int READ_MASK_FIELD_NUMBER
Field Value
Static Methods
public static ListModelsRequest getDefaultInstance()
Returns
public static final Descriptors.Descriptor getDescriptor()
Returns
public static ListModelsRequest.Builder newBuilder()
Returns
public static ListModelsRequest.Builder newBuilder(ListModelsRequest prototype)
Parameter
Returns
public static ListModelsRequest parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static ListModelsRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static ListModelsRequest parseFrom(byte[] data)
Parameter
Name | Description |
data | byte[]
|
Returns
Exceptions
public static ListModelsRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static ListModelsRequest parseFrom(ByteString data)
Parameter
Returns
Exceptions
public static ListModelsRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static ListModelsRequest parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static ListModelsRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static ListModelsRequest parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static ListModelsRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static ListModelsRequest parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
public static ListModelsRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static Parser<ListModelsRequest> parser()
Returns
Methods
public boolean equals(Object obj)
Parameter
Returns
Overrides
public ListModelsRequest getDefaultInstanceForType()
Returns
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
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 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
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
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
public Parser<ListModelsRequest> getParserForType()
Returns
Overrides
public FieldMask getReadMask()
Mask specifying which fields to read.
.google.protobuf.FieldMask read_mask = 5;
Returns
public FieldMaskOrBuilder getReadMaskOrBuilder()
Mask specifying which fields to read.
.google.protobuf.FieldMask read_mask = 5;
Returns
public int getSerializedSize()
Returns
Overrides
public final UnknownFieldSet getUnknownFields()
Returns
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
Overrides
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
public final boolean isInitialized()
Returns
Overrides
public ListModelsRequest.Builder newBuilderForType()
Returns
protected ListModelsRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
public ListModelsRequest.Builder toBuilder()
Returns
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions